@aztec/pxe 4.0.0-rc.1 → 4.0.0-rc.10
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/config/package_info.js +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.d.ts +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.js +4 -4
- package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +5 -5
- package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts.map +1 -1
- package/dest/contract_function_simulator/execution_tagging_index_cache.js +3 -3
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +1 -1
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/private_execution_oracle.js +8 -8
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +1 -1
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +4 -7
- 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/debug/pxe_debug_utils.d.ts +2 -2
- 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 +2 -1
- package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
- package/dest/entrypoints/client/bundle/index.js +1 -0
- package/dest/entrypoints/client/lazy/index.d.ts +2 -1
- package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
- package/dest/entrypoints/client/lazy/index.js +1 -0
- package/dest/logs/log_service.d.ts +1 -1
- package/dest/logs/log_service.d.ts.map +1 -1
- package/dest/logs/log_service.js +4 -4
- 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 +6 -6
- package/dest/pxe.d.ts.map +1 -1
- package/dest/pxe.js +27 -23
- 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/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 +5 -5
- package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
- package/dest/storage/tagging_store/sender_tagging_store.js +4 -4
- package/dest/tagging/index.d.ts +2 -2
- 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 +3 -3
- 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 +3 -6
- package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +4 -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 +14 -15
- package/package.json +16 -16
- package/src/config/package_info.ts +1 -1
- package/src/contract_function_simulator/contract_function_simulator.ts +10 -4
- package/src/contract_function_simulator/execution_tagging_index_cache.ts +5 -5
- package/src/contract_function_simulator/oracle/private_execution_oracle.ts +12 -9
- package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +8 -7
- package/src/contract_logging.ts +39 -0
- package/src/debug/pxe_debug_utils.ts +4 -4
- package/src/entrypoints/client/bundle/index.ts +1 -0
- package/src/entrypoints/client/lazy/index.ts +1 -0
- package/src/logs/log_service.ts +10 -5
- package/src/private_kernel/private_kernel_oracle.ts +7 -7
- package/src/pxe.ts +33 -30
- package/src/storage/contract_store/contract_store.ts +170 -71
- package/src/storage/tagging_store/recipient_tagging_store.ts +9 -5
- package/src/storage/tagging_store/sender_tagging_store.ts +8 -8
- package/src/tagging/index.ts +1 -1
- package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +3 -6
- package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
- package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +4 -9
- package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +11 -20
package/src/pxe.ts
CHANGED
|
@@ -47,7 +47,7 @@ import {
|
|
|
47
47
|
TxProfileResult,
|
|
48
48
|
TxProvingResult,
|
|
49
49
|
TxSimulationResult,
|
|
50
|
-
|
|
50
|
+
UtilityExecutionResult,
|
|
51
51
|
} from '@aztec/stdlib/tx';
|
|
52
52
|
|
|
53
53
|
import { inspect } from 'util';
|
|
@@ -61,6 +61,7 @@ import {
|
|
|
61
61
|
generateSimulatedProvingResult,
|
|
62
62
|
} from './contract_function_simulator/contract_function_simulator.js';
|
|
63
63
|
import { ProxiedContractStoreFactory } from './contract_function_simulator/proxied_contract_data_source.js';
|
|
64
|
+
import { displayDebugLogs } from './contract_logging.js';
|
|
64
65
|
import { ContractSyncService } from './contract_sync/contract_sync_service.js';
|
|
65
66
|
import { readCurrentClassId } from './contract_sync/helpers.js';
|
|
66
67
|
import { PXEDebugUtils } from './debug/pxe_debug_utils.js';
|
|
@@ -111,8 +112,8 @@ export type SimulateTxOpts = {
|
|
|
111
112
|
scopes: AccessScopes;
|
|
112
113
|
};
|
|
113
114
|
|
|
114
|
-
/** Options for PXE.
|
|
115
|
-
export type
|
|
115
|
+
/** Options for PXE.executeUtility. */
|
|
116
|
+
export type ExecuteUtilityOpts = {
|
|
116
117
|
/** The authentication witnesses required for the function call. */
|
|
117
118
|
authwits?: AuthWitness[];
|
|
118
119
|
/** The accounts whose notes we can access in this call */
|
|
@@ -264,7 +265,7 @@ export class PXE {
|
|
|
264
265
|
debugUtils.setPXEHelpers(
|
|
265
266
|
pxe.#putInJobQueue.bind(pxe),
|
|
266
267
|
pxe.#getSimulatorForTx.bind(pxe),
|
|
267
|
-
pxe.#
|
|
268
|
+
pxe.#executeUtility.bind(pxe),
|
|
268
269
|
);
|
|
269
270
|
|
|
270
271
|
pxe.jobQueue.start();
|
|
@@ -344,9 +345,8 @@ export class PXE {
|
|
|
344
345
|
async #registerProtocolContracts() {
|
|
345
346
|
const registered: Record<string, string> = {};
|
|
346
347
|
for (const name of protocolContractNames) {
|
|
347
|
-
const { address,
|
|
348
|
-
|
|
349
|
-
await this.contractStore.addContractArtifact(contractClass.id, artifact);
|
|
348
|
+
const { address, instance, artifact } = await this.protocolContractsProvider.getProtocolContractArtifact(name);
|
|
349
|
+
await this.contractStore.addContractArtifact(artifact);
|
|
350
350
|
await this.contractStore.addContractInstance(instance);
|
|
351
351
|
registered[name] = address.toString();
|
|
352
352
|
}
|
|
@@ -370,7 +370,7 @@ export class PXE {
|
|
|
370
370
|
contractAddress,
|
|
371
371
|
functionSelector,
|
|
372
372
|
(privateSyncCall, execScopes) =>
|
|
373
|
-
this.#
|
|
373
|
+
this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
374
374
|
anchorBlockHeader,
|
|
375
375
|
jobId,
|
|
376
376
|
scopes,
|
|
@@ -394,16 +394,16 @@ export class PXE {
|
|
|
394
394
|
}
|
|
395
395
|
|
|
396
396
|
/**
|
|
397
|
-
*
|
|
397
|
+
* Execute a utility function call on the given contract.
|
|
398
398
|
* @param contractFunctionSimulator - The simulator to use for the function call.
|
|
399
399
|
* @param call - The function call to execute.
|
|
400
400
|
* @param authWitnesses - Authentication witnesses required for the function call.
|
|
401
401
|
* @param scopes - Optional array of account addresses whose notes can be accessed in this call. Defaults to all
|
|
402
402
|
* accounts if not specified.
|
|
403
403
|
* @param jobId - The job ID for staged writes.
|
|
404
|
-
* @returns The
|
|
404
|
+
* @returns The execution result containing the outputs of the utility function.
|
|
405
405
|
*/
|
|
406
|
-
async #
|
|
406
|
+
async #executeUtility(
|
|
407
407
|
contractFunctionSimulator: ContractFunctionSimulator,
|
|
408
408
|
call: FunctionCall,
|
|
409
409
|
authWitnesses: AuthWitness[] | undefined,
|
|
@@ -601,8 +601,7 @@ export class PXE {
|
|
|
601
601
|
* @param artifact - The build artifact for the contract class.
|
|
602
602
|
*/
|
|
603
603
|
public async registerContractClass(artifact: ContractArtifact): Promise<void> {
|
|
604
|
-
const
|
|
605
|
-
await this.contractStore.addContractArtifact(contractClassId, artifact);
|
|
604
|
+
const contractClassId = await this.contractStore.addContractArtifact(artifact);
|
|
606
605
|
this.log.info(`Added contract class ${artifact.name} with id ${contractClassId}`);
|
|
607
606
|
}
|
|
608
607
|
|
|
@@ -621,17 +620,17 @@ export class PXE {
|
|
|
621
620
|
if (artifact) {
|
|
622
621
|
// If the user provides an artifact, validate it against the expected class id and register it
|
|
623
622
|
const contractClass = await getContractClassFromArtifact(artifact);
|
|
624
|
-
|
|
625
|
-
if (!contractClassId.equals(instance.currentContractClassId)) {
|
|
623
|
+
if (!contractClass.id.equals(instance.currentContractClassId)) {
|
|
626
624
|
throw new Error(
|
|
627
|
-
`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})`,
|
|
628
626
|
);
|
|
629
627
|
}
|
|
630
628
|
const computedAddress = await computeContractAddressFromInstance(instance);
|
|
631
629
|
if (!computedAddress.equals(instance.address)) {
|
|
632
630
|
throw new Error('Added a contract in which the address does not match the contract instance.');
|
|
633
631
|
}
|
|
634
|
-
|
|
632
|
+
|
|
633
|
+
await this.contractStore.addContractArtifact(artifact, contractClass);
|
|
635
634
|
|
|
636
635
|
const publicFunctionSignatures = artifact.functions
|
|
637
636
|
.filter(fn => fn.functionType === FunctionType.PUBLIC)
|
|
@@ -680,15 +679,16 @@ export class PXE {
|
|
|
680
679
|
throw new Error('Could not update contract to a class different from the current one.');
|
|
681
680
|
}
|
|
682
681
|
|
|
683
|
-
await this.contractStore.addContractArtifact(contractClass.id, artifact);
|
|
684
|
-
|
|
685
682
|
const publicFunctionSignatures = artifact.functions
|
|
686
683
|
.filter(fn => fn.functionType === FunctionType.PUBLIC)
|
|
687
684
|
.map(fn => decodeFunctionSignature(fn.name, fn.parameters));
|
|
688
685
|
await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
|
|
689
686
|
|
|
690
687
|
currentInstance.currentContractClassId = contractClass.id;
|
|
691
|
-
await
|
|
688
|
+
await Promise.all([
|
|
689
|
+
this.contractStore.addContractArtifact(artifact, contractClass),
|
|
690
|
+
this.contractStore.addContractInstance(currentInstance),
|
|
691
|
+
]);
|
|
692
692
|
this.log.info(`Updated contract ${artifact.name} at ${contractAddress.toString()} to class ${contractClass.id}`);
|
|
693
693
|
});
|
|
694
694
|
}
|
|
@@ -947,6 +947,9 @@ export class PXE {
|
|
|
947
947
|
const publicSimulationTimer = new Timer();
|
|
948
948
|
publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement);
|
|
949
949
|
publicSimulationTime = publicSimulationTimer.ms();
|
|
950
|
+
if (publicOutput?.debugLogs?.length) {
|
|
951
|
+
await displayDebugLogs(publicOutput.debugLogs, addr => this.contractStore.getDebugContractName(addr));
|
|
952
|
+
}
|
|
950
953
|
}
|
|
951
954
|
|
|
952
955
|
let validationTime: number | undefined;
|
|
@@ -1013,16 +1016,16 @@ export class PXE {
|
|
|
1013
1016
|
}
|
|
1014
1017
|
|
|
1015
1018
|
/**
|
|
1016
|
-
*
|
|
1019
|
+
* Executes a contract utility function.
|
|
1017
1020
|
* @param call - The function call containing the function details, arguments, and target contract address.
|
|
1018
1021
|
*/
|
|
1019
|
-
public
|
|
1022
|
+
public executeUtility(
|
|
1020
1023
|
call: FunctionCall,
|
|
1021
|
-
{ authwits, scopes }:
|
|
1022
|
-
): Promise<
|
|
1023
|
-
// We disable concurrent
|
|
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.
|
|
1024
1027
|
// to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
|
|
1025
|
-
// 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).
|
|
1026
1029
|
return this.#putInJobQueue(async jobId => {
|
|
1027
1030
|
try {
|
|
1028
1031
|
const totalTimer = new Timer();
|
|
@@ -1037,13 +1040,13 @@ export class PXE {
|
|
|
1037
1040
|
call.to,
|
|
1038
1041
|
call.selector,
|
|
1039
1042
|
(privateSyncCall, execScopes) =>
|
|
1040
|
-
this.#
|
|
1043
|
+
this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
1041
1044
|
anchorBlockHeader,
|
|
1042
1045
|
jobId,
|
|
1043
1046
|
scopes,
|
|
1044
1047
|
);
|
|
1045
1048
|
|
|
1046
|
-
const executionResult = await this.#
|
|
1049
|
+
const executionResult = await this.#executeUtility(
|
|
1047
1050
|
contractFunctionSimulator,
|
|
1048
1051
|
call,
|
|
1049
1052
|
authwits ?? [],
|
|
@@ -1070,7 +1073,7 @@ export class PXE {
|
|
|
1070
1073
|
const stringifiedArgs = args.map(arg => arg.toString()).join(', ');
|
|
1071
1074
|
throw this.#contextualizeError(
|
|
1072
1075
|
err,
|
|
1073
|
-
`
|
|
1076
|
+
`executeUtility ${to}:${name}(${stringifiedArgs})`,
|
|
1074
1077
|
`scopes=${scopes === 'ALL_SCOPES' ? scopes : scopes.map(s => s.toString()).join(', ')}`,
|
|
1075
1078
|
);
|
|
1076
1079
|
}
|
|
@@ -1108,7 +1111,7 @@ export class PXE {
|
|
|
1108
1111
|
filter.contractAddress,
|
|
1109
1112
|
null,
|
|
1110
1113
|
async (privateSyncCall, execScopes) =>
|
|
1111
|
-
await this.#
|
|
1114
|
+
await this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
1112
1115
|
anchorBlockHeader,
|
|
1113
1116
|
jobId,
|
|
1114
1117
|
filter.scopes,
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { FUNCTION_TREE_HEIGHT } from '@aztec/constants';
|
|
2
|
-
import
|
|
2
|
+
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
3
3
|
import { toArray } from '@aztec/foundation/iterable';
|
|
4
|
+
import { BufferReader, numToUInt8, serializeToBuffer } from '@aztec/foundation/serialize';
|
|
4
5
|
import type { MembershipWitness } from '@aztec/foundation/trees';
|
|
5
6
|
import type { AztecAsyncKVStore, AztecAsyncMap } from '@aztec/kv-store';
|
|
6
7
|
import {
|
|
@@ -19,7 +20,8 @@ import {
|
|
|
19
20
|
} from '@aztec/stdlib/abi';
|
|
20
21
|
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
21
22
|
import {
|
|
22
|
-
type
|
|
23
|
+
type ContractClassIdPreimage,
|
|
24
|
+
type ContractClassWithId,
|
|
23
25
|
type ContractInstanceWithAddress,
|
|
24
26
|
SerializableContractInstance,
|
|
25
27
|
getContractClassFromArtifact,
|
|
@@ -27,6 +29,68 @@ import {
|
|
|
27
29
|
|
|
28
30
|
import { PrivateFunctionsTree } from './private_functions_tree.js';
|
|
29
31
|
|
|
32
|
+
const VERSION = 1 as const;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* All contract class data except the large packedBytecode.
|
|
36
|
+
* The expensive data from the ContractClass is precomputed and stored in this format to avoid redundant hashing.
|
|
37
|
+
* Since we have to store the artifacts anyway, the final ContractClass is reconstructed by combining this data
|
|
38
|
+
* with the packedBytecode obtained from the former. That way we can have quick class lookups without wasted storage.
|
|
39
|
+
*/
|
|
40
|
+
export class SerializableContractClassData {
|
|
41
|
+
public readonly version = VERSION;
|
|
42
|
+
public readonly id: Fr;
|
|
43
|
+
public readonly artifactHash: Fr;
|
|
44
|
+
public readonly privateFunctionsRoot: Fr;
|
|
45
|
+
public readonly publicBytecodeCommitment: Fr;
|
|
46
|
+
public readonly privateFunctions: { selector: FunctionSelector; vkHash: Fr }[];
|
|
47
|
+
|
|
48
|
+
constructor(
|
|
49
|
+
data: ContractClassIdPreimage & {
|
|
50
|
+
id: Fr;
|
|
51
|
+
privateFunctions: { selector: FunctionSelector; vkHash: Fr }[];
|
|
52
|
+
},
|
|
53
|
+
) {
|
|
54
|
+
this.id = data.id;
|
|
55
|
+
this.artifactHash = data.artifactHash;
|
|
56
|
+
this.privateFunctionsRoot = data.privateFunctionsRoot;
|
|
57
|
+
this.publicBytecodeCommitment = data.publicBytecodeCommitment;
|
|
58
|
+
this.privateFunctions = data.privateFunctions;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
toBuffer(): Buffer {
|
|
62
|
+
return serializeToBuffer(
|
|
63
|
+
numToUInt8(this.version),
|
|
64
|
+
this.id,
|
|
65
|
+
this.artifactHash,
|
|
66
|
+
this.privateFunctionsRoot,
|
|
67
|
+
this.publicBytecodeCommitment,
|
|
68
|
+
this.privateFunctions.length,
|
|
69
|
+
...this.privateFunctions.map(fn => serializeToBuffer(fn.selector, fn.vkHash)),
|
|
70
|
+
);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
static fromBuffer(bufferOrReader: Buffer | BufferReader): SerializableContractClassData {
|
|
74
|
+
const reader = BufferReader.asReader(bufferOrReader);
|
|
75
|
+
const version = reader.readUInt8();
|
|
76
|
+
if (version !== VERSION) {
|
|
77
|
+
throw new Error(`Unexpected contract class data version ${version}`);
|
|
78
|
+
}
|
|
79
|
+
return new SerializableContractClassData({
|
|
80
|
+
id: reader.readObject(Fr),
|
|
81
|
+
artifactHash: reader.readObject(Fr),
|
|
82
|
+
privateFunctionsRoot: reader.readObject(Fr),
|
|
83
|
+
publicBytecodeCommitment: reader.readObject(Fr),
|
|
84
|
+
privateFunctions: reader.readVector({
|
|
85
|
+
fromBuffer: (r: BufferReader) => ({
|
|
86
|
+
selector: r.readObject(FunctionSelector),
|
|
87
|
+
vkHash: r.readObject(Fr),
|
|
88
|
+
}),
|
|
89
|
+
}),
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
|
|
30
94
|
/**
|
|
31
95
|
* ContractStore serves as a data manager and retriever for Aztec.nr contracts.
|
|
32
96
|
* It provides methods to obtain contract addresses, function ABI, bytecode, and membership witnesses
|
|
@@ -39,42 +103,68 @@ export class ContractStore {
|
|
|
39
103
|
// TODO: Update it to be LRU cache so that it doesn't keep all the data all the time.
|
|
40
104
|
#privateFunctionTrees: Map<string, PrivateFunctionsTree> = new Map();
|
|
41
105
|
|
|
42
|
-
/**
|
|
106
|
+
/**
|
|
107
|
+
* In-memory cache of deserialized ContractArtifact objects, keyed by class id string.
|
|
108
|
+
* Avoids repeated LMDB reads + JSON.parse + Zod validation on every oracle call.
|
|
109
|
+
* Artifacts are large but immutable after registration — safe to cache for the lifetime of the store.
|
|
110
|
+
*/
|
|
111
|
+
// TODO: Update it to be LRU cache so that it doesn't keep all the data all the time.
|
|
112
|
+
#contractArtifactCache: Map<string, ContractArtifact> = new Map();
|
|
113
|
+
|
|
114
|
+
/** Map from contract address to contract class id (avoids KV round-trip on hot path). */
|
|
43
115
|
#contractClassIdMap: Map<string, Fr> = new Map();
|
|
44
116
|
|
|
45
117
|
#store: AztecAsyncKVStore;
|
|
46
118
|
#contractArtifacts: AztecAsyncMap<string, Buffer>;
|
|
119
|
+
#contractClassData: AztecAsyncMap<string, Buffer>;
|
|
47
120
|
#contractInstances: AztecAsyncMap<string, Buffer>;
|
|
48
121
|
|
|
49
122
|
constructor(store: AztecAsyncKVStore) {
|
|
50
123
|
this.#store = store;
|
|
51
124
|
this.#contractArtifacts = store.openMap('contract_artifacts');
|
|
125
|
+
this.#contractClassData = store.openMap('contract_classes');
|
|
52
126
|
this.#contractInstances = store.openMap('contracts_instances');
|
|
53
127
|
}
|
|
54
128
|
|
|
55
129
|
// Setters
|
|
56
130
|
|
|
57
|
-
|
|
58
|
-
|
|
131
|
+
/**
|
|
132
|
+
* Registers a new contract artifact and its corresponding class data.
|
|
133
|
+
* IMPORTANT: This method does not verify that the provided artifact matches the class data or that the class id matches the artifact.
|
|
134
|
+
* It is the caller's responsibility to ensure the consistency and correctness of the provided data.
|
|
135
|
+
* This is done to avoid redundant, expensive contract class computations
|
|
136
|
+
*/
|
|
137
|
+
public async addContractArtifact(
|
|
138
|
+
contract: ContractArtifact,
|
|
139
|
+
contractClassWithIdAndPreimage?: ContractClassWithId & ContractClassIdPreimage,
|
|
140
|
+
): Promise<Fr> {
|
|
141
|
+
const contractClass = contractClassWithIdAndPreimage ?? (await getContractClassFromArtifact(contract));
|
|
142
|
+
const key = contractClass.id.toString();
|
|
143
|
+
|
|
144
|
+
if (this.#contractArtifactCache.has(key)) {
|
|
145
|
+
return contractClass.id;
|
|
146
|
+
}
|
|
147
|
+
|
|
59
148
|
const privateFunctions = contract.functions.filter(
|
|
60
149
|
functionArtifact => functionArtifact.functionType === FunctionType.PRIVATE,
|
|
61
150
|
);
|
|
62
|
-
|
|
63
151
|
const privateSelectors = await Promise.all(
|
|
64
|
-
privateFunctions.map(async
|
|
65
|
-
(
|
|
66
|
-
await FunctionSelector.fromNameAndParameters(privateFunctionArtifact.name, privateFunctionArtifact.parameters)
|
|
67
|
-
).toString(),
|
|
152
|
+
privateFunctions.map(async fn =>
|
|
153
|
+
(await FunctionSelector.fromNameAndParameters(fn.name, fn.parameters)).toString(),
|
|
68
154
|
),
|
|
69
155
|
);
|
|
70
|
-
|
|
71
156
|
if (privateSelectors.length !== new Set(privateSelectors).size) {
|
|
72
157
|
throw new Error('Repeated function selectors of private functions');
|
|
73
158
|
}
|
|
74
159
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
)
|
|
160
|
+
this.#contractArtifactCache.set(key, contract);
|
|
161
|
+
|
|
162
|
+
await this.#store.transactionAsync(async () => {
|
|
163
|
+
await this.#contractArtifacts.set(key, contractArtifactToBuffer(contract));
|
|
164
|
+
await this.#contractClassData.set(key, new SerializableContractClassData(contractClass).toBuffer());
|
|
165
|
+
});
|
|
166
|
+
|
|
167
|
+
return contractClass.id;
|
|
78
168
|
}
|
|
79
169
|
|
|
80
170
|
async addContractInstance(contract: ContractInstanceWithAddress): Promise<void> {
|
|
@@ -89,26 +179,17 @@ export class ContractStore {
|
|
|
89
179
|
// Private getters
|
|
90
180
|
|
|
91
181
|
async #getContractClassId(contractAddress: AztecAddress): Promise<Fr | undefined> {
|
|
92
|
-
|
|
182
|
+
const key = contractAddress.toString();
|
|
183
|
+
if (!this.#contractClassIdMap.has(key)) {
|
|
93
184
|
const instance = await this.getContractInstance(contractAddress);
|
|
94
185
|
if (!instance) {
|
|
95
186
|
return;
|
|
96
187
|
}
|
|
97
|
-
this.#contractClassIdMap.set(
|
|
188
|
+
this.#contractClassIdMap.set(key, instance.currentContractClassId);
|
|
98
189
|
}
|
|
99
|
-
return this.#contractClassIdMap.get(
|
|
190
|
+
return this.#contractClassIdMap.get(key);
|
|
100
191
|
}
|
|
101
192
|
|
|
102
|
-
/**
|
|
103
|
-
* Retrieve or create a ContractTree instance based on the provided class id.
|
|
104
|
-
* If an existing tree with the same class id is found in the cache, it will be returned.
|
|
105
|
-
* Otherwise, a new ContractTree instance will be created using the contract data from the database
|
|
106
|
-
* and added to the cache before returning.
|
|
107
|
-
*
|
|
108
|
-
* @param classId - The class id of the contract for which the ContractTree is required.
|
|
109
|
-
* @returns A ContractTree instance associated with the specified contract address.
|
|
110
|
-
* @throws An Error if the contract is not found in the ContractDatabase.
|
|
111
|
-
*/
|
|
112
193
|
async #getPrivateFunctionTreeForClassId(classId: Fr): Promise<PrivateFunctionsTree | undefined> {
|
|
113
194
|
if (!this.#privateFunctionTrees.has(classId.toString())) {
|
|
114
195
|
const artifact = await this.getContractArtifact(classId);
|
|
@@ -121,9 +202,9 @@ export class ContractStore {
|
|
|
121
202
|
return this.#privateFunctionTrees.get(classId.toString())!;
|
|
122
203
|
}
|
|
123
204
|
|
|
124
|
-
async #
|
|
125
|
-
const
|
|
126
|
-
return
|
|
205
|
+
async #getArtifactByAddress(contractAddress: AztecAddress): Promise<ContractArtifact | undefined> {
|
|
206
|
+
const classId = await this.#getContractClassId(contractAddress);
|
|
207
|
+
return classId && this.getContractArtifact(classId);
|
|
127
208
|
}
|
|
128
209
|
|
|
129
210
|
// Public getters
|
|
@@ -135,7 +216,7 @@ export class ContractStore {
|
|
|
135
216
|
});
|
|
136
217
|
}
|
|
137
218
|
|
|
138
|
-
/** Returns a contract instance for a given address.
|
|
219
|
+
/** Returns a contract instance for a given address. */
|
|
139
220
|
public getContractInstance(contractAddress: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
|
|
140
221
|
return this.#store.transactionAsync(async () => {
|
|
141
222
|
const contract = await this.#contractInstances.getAsync(contractAddress.toString());
|
|
@@ -143,18 +224,39 @@ export class ContractStore {
|
|
|
143
224
|
});
|
|
144
225
|
}
|
|
145
226
|
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
227
|
+
/** Returns the raw contract artifact for a given class id. */
|
|
228
|
+
public async getContractArtifact(contractClassId: Fr): Promise<ContractArtifact | undefined> {
|
|
229
|
+
const key = contractClassId.toString();
|
|
230
|
+
const cached = this.#contractArtifactCache.get(key);
|
|
231
|
+
if (cached) {
|
|
232
|
+
return cached;
|
|
233
|
+
}
|
|
234
|
+
const artifact = await this.#store.transactionAsync(async () => {
|
|
235
|
+
const buf = await this.#contractArtifacts.getAsync(key);
|
|
236
|
+
return buf && contractArtifactFromBuffer(buf);
|
|
151
237
|
});
|
|
238
|
+
if (artifact) {
|
|
239
|
+
this.#contractArtifactCache.set(key, artifact);
|
|
240
|
+
}
|
|
241
|
+
return artifact;
|
|
152
242
|
}
|
|
153
243
|
|
|
154
|
-
/** Returns a contract class for a given class id.
|
|
155
|
-
public async
|
|
244
|
+
/** Returns a contract class for a given class id. */
|
|
245
|
+
public async getContractClassWithPreimage(
|
|
246
|
+
contractClassId: Fr,
|
|
247
|
+
): Promise<(ContractClassWithId & ContractClassIdPreimage) | undefined> {
|
|
248
|
+
const key = contractClassId.toString();
|
|
249
|
+
const buf = await this.#contractClassData.getAsync(key);
|
|
250
|
+
if (!buf) {
|
|
251
|
+
return undefined;
|
|
252
|
+
}
|
|
253
|
+
const classData = SerializableContractClassData.fromBuffer(buf);
|
|
156
254
|
const artifact = await this.getContractArtifact(contractClassId);
|
|
157
|
-
|
|
255
|
+
if (!artifact) {
|
|
256
|
+
return undefined;
|
|
257
|
+
}
|
|
258
|
+
const packedBytecode = artifact.functions.find(f => f.name === 'public_dispatch')?.bytecode ?? Buffer.alloc(0);
|
|
259
|
+
return { ...classData, packedBytecode };
|
|
158
260
|
}
|
|
159
261
|
|
|
160
262
|
public async getContract(
|
|
@@ -173,8 +275,6 @@ export class ContractStore {
|
|
|
173
275
|
|
|
174
276
|
/**
|
|
175
277
|
* Retrieves the artifact of a specified function within a given contract.
|
|
176
|
-
* The function is identified by its selector, which is a unique code generated from the function's signature.
|
|
177
|
-
* Throws an error if the contract address or function selector are invalid or not found.
|
|
178
278
|
*
|
|
179
279
|
* @param contractAddress - The AztecAddress representing the contract containing the function.
|
|
180
280
|
* @param selector - The function selector.
|
|
@@ -184,9 +284,12 @@ export class ContractStore {
|
|
|
184
284
|
contractAddress: AztecAddress,
|
|
185
285
|
selector: FunctionSelector,
|
|
186
286
|
): Promise<FunctionArtifactWithContractName | undefined> {
|
|
187
|
-
const artifact = await this.#
|
|
188
|
-
|
|
189
|
-
|
|
287
|
+
const artifact = await this.#getArtifactByAddress(contractAddress);
|
|
288
|
+
if (!artifact) {
|
|
289
|
+
return undefined;
|
|
290
|
+
}
|
|
291
|
+
const fn = await this.#findFunctionArtifactBySelector(artifact, selector);
|
|
292
|
+
return fn && { ...fn, contractName: artifact.name };
|
|
190
293
|
}
|
|
191
294
|
|
|
192
295
|
public async getFunctionArtifactWithDebugMetadata(
|
|
@@ -207,50 +310,48 @@ export class ContractStore {
|
|
|
207
310
|
public async getPublicFunctionArtifact(
|
|
208
311
|
contractAddress: AztecAddress,
|
|
209
312
|
): Promise<FunctionArtifactWithContractName | undefined> {
|
|
210
|
-
const artifact = await this.#
|
|
211
|
-
const
|
|
212
|
-
return
|
|
313
|
+
const artifact = await this.#getArtifactByAddress(contractAddress);
|
|
314
|
+
const fn = artifact && artifact.functions.find(f => f.functionType === FunctionType.PUBLIC);
|
|
315
|
+
return fn && { ...fn, contractName: artifact.name };
|
|
213
316
|
}
|
|
214
317
|
|
|
215
318
|
public async getFunctionAbi(
|
|
216
319
|
contractAddress: AztecAddress,
|
|
217
320
|
selector: FunctionSelector,
|
|
218
321
|
): Promise<FunctionAbi | undefined> {
|
|
219
|
-
const artifact = await this.#
|
|
322
|
+
const artifact = await this.#getArtifactByAddress(contractAddress);
|
|
220
323
|
return artifact && (await this.#findFunctionAbiBySelector(artifact, selector));
|
|
221
324
|
}
|
|
222
325
|
|
|
223
326
|
/**
|
|
224
327
|
* Retrieves the debug metadata of a specified function within a given contract.
|
|
225
|
-
* The function is identified by its selector, which is a unique code generated from the function's signature.
|
|
226
|
-
* Returns undefined if the debug metadata for the given function is not found.
|
|
227
|
-
* Throws if the contract has not been added to the database.
|
|
228
328
|
*
|
|
229
329
|
* @param contractAddress - The AztecAddress representing the contract containing the function.
|
|
230
330
|
* @param selector - The function selector.
|
|
231
|
-
* @returns The corresponding function's
|
|
331
|
+
* @returns The corresponding function's debug metadata, or undefined.
|
|
232
332
|
*/
|
|
233
333
|
public async getFunctionDebugMetadata(
|
|
234
334
|
contractAddress: AztecAddress,
|
|
235
335
|
selector: FunctionSelector,
|
|
236
336
|
): Promise<FunctionDebugMetadata | undefined> {
|
|
237
|
-
const artifact = await this.#
|
|
238
|
-
|
|
239
|
-
|
|
337
|
+
const artifact = await this.#getArtifactByAddress(contractAddress);
|
|
338
|
+
if (!artifact) {
|
|
339
|
+
return undefined;
|
|
340
|
+
}
|
|
341
|
+
const fn = await this.#findFunctionArtifactBySelector(artifact, selector);
|
|
342
|
+
return fn && getFunctionDebugMetadata(artifact, fn);
|
|
240
343
|
}
|
|
241
344
|
|
|
242
345
|
public async getPublicFunctionDebugMetadata(
|
|
243
346
|
contractAddress: AztecAddress,
|
|
244
347
|
): Promise<FunctionDebugMetadata | undefined> {
|
|
245
|
-
const artifact = await this.#
|
|
246
|
-
const
|
|
247
|
-
return
|
|
348
|
+
const artifact = await this.#getArtifactByAddress(contractAddress);
|
|
349
|
+
const fn = artifact && artifact.functions.find(f => f.functionType === FunctionType.PUBLIC);
|
|
350
|
+
return fn && getFunctionDebugMetadata(artifact, fn);
|
|
248
351
|
}
|
|
249
352
|
|
|
250
353
|
/**
|
|
251
354
|
* Retrieve the function membership witness for the given contract class and function selector.
|
|
252
|
-
* The function membership witness represents a proof that the function belongs to the specified contract.
|
|
253
|
-
* Throws an error if the contract address or function selector is unknown.
|
|
254
355
|
*
|
|
255
356
|
* @param contractClassId - The id of the class.
|
|
256
357
|
* @param selector - The function selector.
|
|
@@ -265,23 +366,21 @@ export class ContractStore {
|
|
|
265
366
|
}
|
|
266
367
|
|
|
267
368
|
public async getDebugContractName(contractAddress: AztecAddress) {
|
|
268
|
-
const artifact = await this.#
|
|
369
|
+
const artifact = await this.#getArtifactByAddress(contractAddress);
|
|
269
370
|
return artifact?.name;
|
|
270
371
|
}
|
|
271
372
|
|
|
272
373
|
public async getDebugFunctionName(contractAddress: AztecAddress, selector: FunctionSelector) {
|
|
273
|
-
const artifact = await this.#
|
|
274
|
-
const
|
|
275
|
-
return `${artifact?.name ?? contractAddress}:${
|
|
374
|
+
const artifact = await this.#getArtifactByAddress(contractAddress);
|
|
375
|
+
const fn = artifact && (await this.#findFunctionAbiBySelector(artifact, selector));
|
|
376
|
+
return `${artifact?.name ?? contractAddress}:${fn?.name ?? selector}`;
|
|
276
377
|
}
|
|
277
378
|
|
|
278
379
|
async #findFunctionArtifactBySelector(
|
|
279
380
|
artifact: ContractArtifact,
|
|
280
381
|
selector: FunctionSelector,
|
|
281
382
|
): Promise<FunctionArtifact | undefined> {
|
|
282
|
-
const
|
|
283
|
-
for (let i = 0; i < functions.length; i++) {
|
|
284
|
-
const fn = functions[i];
|
|
383
|
+
for (const fn of artifact.functions) {
|
|
285
384
|
const fnSelector = await FunctionSelector.fromNameAndParameters(fn.name, fn.parameters);
|
|
286
385
|
if (fnSelector.equals(selector)) {
|
|
287
386
|
return fn;
|
|
@@ -293,9 +392,7 @@ export class ContractStore {
|
|
|
293
392
|
artifact: ContractArtifact,
|
|
294
393
|
selector: FunctionSelector,
|
|
295
394
|
): Promise<FunctionAbi | undefined> {
|
|
296
|
-
const
|
|
297
|
-
for (let i = 0; i < functions.length; i++) {
|
|
298
|
-
const fn = functions[i];
|
|
395
|
+
for (const fn of [...artifact.functions, ...(artifact.nonDispatchPublicFunctions ?? [])]) {
|
|
299
396
|
const fnSelector = await FunctionSelector.fromNameAndParameters(fn.name, fn.parameters);
|
|
300
397
|
if (fnSelector.equals(selector)) {
|
|
301
398
|
return fn;
|
|
@@ -316,10 +413,12 @@ export class ContractStore {
|
|
|
316
413
|
throw new Error(`Unknown function ${functionName} in contract ${contract.name}.`);
|
|
317
414
|
}
|
|
318
415
|
|
|
416
|
+
const selector = await FunctionSelector.fromNameAndParameters(functionDao.name, functionDao.parameters);
|
|
417
|
+
|
|
319
418
|
return FunctionCall.from({
|
|
320
419
|
name: functionDao.name,
|
|
321
420
|
to,
|
|
322
|
-
selector
|
|
421
|
+
selector,
|
|
323
422
|
type: functionDao.functionType,
|
|
324
423
|
hideMsgSender: false,
|
|
325
424
|
isStatic: functionDao.isStatic,
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { AztecAsyncKVStore, AztecAsyncMap } from '@aztec/kv-store';
|
|
2
|
-
import type {
|
|
2
|
+
import type { ExtendedDirectionalAppTaggingSecret } from '@aztec/stdlib/logs';
|
|
3
3
|
|
|
4
4
|
import type { StagedStore } from '../../job_coordinator/job_coordinator.js';
|
|
5
5
|
|
|
@@ -106,11 +106,11 @@ export class RecipientTaggingStore implements StagedStore {
|
|
|
106
106
|
return Promise.resolve();
|
|
107
107
|
}
|
|
108
108
|
|
|
109
|
-
getHighestAgedIndex(secret:
|
|
109
|
+
getHighestAgedIndex(secret: ExtendedDirectionalAppTaggingSecret, jobId: string): Promise<number | undefined> {
|
|
110
110
|
return this.#store.transactionAsync(() => this.#readHighestAgedIndex(jobId, secret.toString()));
|
|
111
111
|
}
|
|
112
112
|
|
|
113
|
-
updateHighestAgedIndex(secret:
|
|
113
|
+
updateHighestAgedIndex(secret: ExtendedDirectionalAppTaggingSecret, index: number, jobId: string): Promise<void> {
|
|
114
114
|
return this.#store.transactionAsync(async () => {
|
|
115
115
|
const currentIndex = await this.#readHighestAgedIndex(jobId, secret.toString());
|
|
116
116
|
if (currentIndex !== undefined && index <= currentIndex) {
|
|
@@ -121,11 +121,15 @@ export class RecipientTaggingStore implements StagedStore {
|
|
|
121
121
|
});
|
|
122
122
|
}
|
|
123
123
|
|
|
124
|
-
getHighestFinalizedIndex(secret:
|
|
124
|
+
getHighestFinalizedIndex(secret: ExtendedDirectionalAppTaggingSecret, jobId: string): Promise<number | undefined> {
|
|
125
125
|
return this.#store.transactionAsync(() => this.#readHighestFinalizedIndex(jobId, secret.toString()));
|
|
126
126
|
}
|
|
127
127
|
|
|
128
|
-
updateHighestFinalizedIndex(
|
|
128
|
+
updateHighestFinalizedIndex(
|
|
129
|
+
secret: ExtendedDirectionalAppTaggingSecret,
|
|
130
|
+
index: number,
|
|
131
|
+
jobId: string,
|
|
132
|
+
): Promise<void> {
|
|
129
133
|
return this.#store.transactionAsync(async () => {
|
|
130
134
|
const currentIndex = await this.#readHighestFinalizedIndex(jobId, secret.toString());
|
|
131
135
|
if (currentIndex !== undefined && index < currentIndex) {
|