@aztec/stdlib 0.0.1-commit.cb6bed7c2 → 0.0.1-commit.cbf2c2d5d
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/abi/abi.d.ts +138 -1
- package/dest/abi/abi.d.ts.map +1 -1
- package/dest/abi/abi.js +10 -2
- package/dest/abi/buffer.d.ts +14 -4
- package/dest/abi/buffer.d.ts.map +1 -1
- package/dest/abi/buffer.js +25 -4
- package/dest/avm/avm.d.ts +300 -300
- package/dest/block/l2_block_source.d.ts +11 -8
- package/dest/block/l2_block_source.d.ts.map +1 -1
- package/dest/checkpoint/validate.js +2 -2
- package/dest/config/index.d.ts +2 -1
- package/dest/config/index.d.ts.map +1 -1
- package/dest/config/index.js +1 -0
- package/dest/config/pipelining-config.d.ts +19 -0
- package/dest/config/pipelining-config.d.ts.map +1 -0
- package/dest/config/pipelining-config.js +18 -0
- package/dest/contract/contract_address.d.ts +3 -3
- package/dest/contract/contract_address.js +3 -3
- package/dest/contract/contract_class_id.d.ts +2 -2
- package/dest/contract/contract_class_id.js +2 -2
- package/dest/contract/index.d.ts +1 -3
- package/dest/contract/index.d.ts.map +1 -1
- package/dest/contract/index.js +0 -2
- package/dest/contract/interfaces/contract_class.d.ts +3 -156
- package/dest/contract/interfaces/contract_class.d.ts.map +1 -1
- package/dest/contract/interfaces/contract_class.js +1 -28
- package/dest/epoch-helpers/index.d.ts +7 -1
- package/dest/epoch-helpers/index.d.ts.map +1 -1
- package/dest/epoch-helpers/index.js +10 -2
- package/dest/hash/hash.d.ts +16 -1
- package/dest/hash/hash.d.ts.map +1 -1
- package/dest/hash/hash.js +24 -0
- package/dest/interfaces/archiver.js +2 -2
- package/dest/interfaces/aztec-node-admin.d.ts +7 -1
- package/dest/interfaces/aztec-node-admin.d.ts.map +1 -1
- package/dest/interfaces/aztec-node.d.ts +3 -2
- package/dest/interfaces/aztec-node.d.ts.map +1 -1
- package/dest/interfaces/aztec-node.js +2 -0
- package/dest/interfaces/block-builder.d.ts +32 -11
- package/dest/interfaces/block-builder.d.ts.map +1 -1
- package/dest/interfaces/block-builder.js +6 -4
- package/dest/interfaces/configs.d.ts +7 -2
- package/dest/interfaces/configs.d.ts.map +1 -1
- package/dest/interfaces/configs.js +1 -0
- package/dest/interfaces/l2_logs_source.d.ts +5 -3
- package/dest/interfaces/l2_logs_source.d.ts.map +1 -1
- package/dest/interfaces/merkle_tree_operations.d.ts +9 -19
- package/dest/interfaces/merkle_tree_operations.d.ts.map +1 -1
- package/dest/interfaces/prover-client.d.ts +6 -1
- package/dest/interfaces/prover-client.d.ts.map +1 -1
- package/dest/interfaces/prover-client.js +7 -1
- package/dest/interfaces/proving-job.d.ts +200 -200
- package/dest/interfaces/world_state.d.ts +5 -4
- package/dest/interfaces/world_state.d.ts.map +1 -1
- package/dest/logs/index.d.ts +2 -1
- package/dest/logs/index.d.ts.map +1 -1
- package/dest/logs/index.js +1 -0
- package/dest/logs/log_filter.d.ts +4 -1
- package/dest/logs/log_filter.d.ts.map +1 -1
- package/dest/logs/log_filter.js +2 -1
- package/dest/logs/tagging_index_range.d.ts +40 -0
- package/dest/logs/tagging_index_range.d.ts.map +1 -0
- package/dest/logs/tagging_index_range.js +8 -0
- package/dest/logs/tx_scoped_l2_log.d.ts +3 -1
- package/dest/logs/tx_scoped_l2_log.d.ts.map +1 -1
- package/dest/logs/tx_scoped_l2_log.js +7 -0
- package/dest/messaging/l1_to_l2_message_source.d.ts +4 -2
- package/dest/messaging/l1_to_l2_message_source.d.ts.map +1 -1
- package/dest/messaging/l2_to_l1_membership.d.ts +32 -6
- package/dest/messaging/l2_to_l1_membership.d.ts.map +1 -1
- package/dest/messaging/l2_to_l1_membership.js +69 -26
- package/dest/noir/index.d.ts +3 -3
- package/dest/noir/index.d.ts.map +1 -1
- package/dest/p2p/checkpoint_proposal.d.ts +1 -1
- package/dest/p2p/checkpoint_proposal.d.ts.map +1 -1
- package/dest/p2p/checkpoint_proposal.js +13 -11
- package/dest/tests/factories.d.ts +2 -4
- package/dest/tests/factories.d.ts.map +1 -1
- package/dest/tests/factories.js +0 -27
- package/dest/tx/private_execution_result.d.ts +6 -6
- package/dest/tx/private_execution_result.d.ts.map +1 -1
- package/dest/tx/private_execution_result.js +6 -6
- package/dest/tx/profiling.d.ts +14 -2
- package/dest/tx/profiling.d.ts.map +1 -1
- package/dest/tx/profiling.js +13 -3
- package/dest/tx/simulated_tx.d.ts +109 -1
- package/dest/tx/simulated_tx.d.ts.map +1 -1
- package/dest/tx/tx_receipt.d.ts +7 -2
- package/dest/tx/tx_receipt.d.ts.map +1 -1
- package/dest/tx/tx_receipt.js +6 -3
- package/dest/tx/validator/error_texts.d.ts +5 -1
- package/dest/tx/validator/error_texts.d.ts.map +1 -1
- package/dest/tx/validator/error_texts.js +6 -0
- package/dest/update-checker/package_version.d.ts +2 -2
- package/dest/update-checker/package_version.d.ts.map +1 -1
- package/dest/update-checker/package_version.js +16 -3
- package/dest/validators/errors.d.ts +6 -1
- package/dest/validators/errors.d.ts.map +1 -1
- package/dest/validators/errors.js +7 -0
- package/dest/versioning/versioning.d.ts +4 -2
- package/dest/versioning/versioning.d.ts.map +1 -1
- package/dest/versioning/versioning.js +4 -1
- package/package.json +8 -8
- package/src/abi/abi.ts +25 -2
- package/src/abi/buffer.ts +25 -4
- package/src/block/l2_block_source.ts +10 -7
- package/src/checkpoint/validate.ts +2 -2
- package/src/config/index.ts +1 -0
- package/src/config/pipelining-config.ts +31 -0
- package/src/contract/contract_address.ts +3 -3
- package/src/contract/contract_class_id.ts +2 -2
- package/src/contract/index.ts +0 -2
- package/src/contract/interfaces/contract_class.ts +2 -82
- package/src/epoch-helpers/index.ts +14 -0
- package/src/gas/README.md +123 -0
- package/src/hash/hash.ts +29 -0
- package/src/interfaces/archiver.ts +2 -2
- package/src/interfaces/aztec-node.ts +10 -1
- package/src/interfaces/block-builder.ts +39 -13
- package/src/interfaces/configs.ts +4 -1
- package/src/interfaces/l2_logs_source.ts +4 -1
- package/src/interfaces/merkle_tree_operations.ts +8 -18
- package/src/interfaces/prover-client.ts +8 -0
- package/src/interfaces/world_state.ts +4 -3
- package/src/logs/index.ts +1 -0
- package/src/logs/log_filter.ts +5 -0
- package/src/logs/tagging_index_range.ts +24 -0
- package/src/logs/tx_scoped_l2_log.ts +16 -0
- package/src/messaging/l1_to_l2_message_source.ts +3 -1
- package/src/messaging/l2_to_l1_membership.ts +98 -33
- package/src/noir/index.ts +2 -2
- package/src/p2p/checkpoint_proposal.ts +23 -20
- package/src/tests/factories.ts +0 -33
- package/src/tx/private_execution_result.ts +5 -5
- package/src/tx/profiling.ts +11 -2
- package/src/tx/tx_receipt.ts +7 -2
- package/src/tx/validator/error_texts.ts +8 -0
- package/src/update-checker/package_version.ts +19 -6
- package/src/validators/errors.ts +9 -0
- package/src/versioning/versioning.ts +4 -1
- package/dest/contract/private_function_membership_proof.d.ts +0 -32
- package/dest/contract/private_function_membership_proof.d.ts.map +0 -1
- package/dest/contract/private_function_membership_proof.js +0 -124
- package/dest/contract/utility_function_membership_proof.d.ts +0 -27
- package/dest/contract/utility_function_membership_proof.d.ts.map +0 -1
- package/dest/contract/utility_function_membership_proof.js +0 -87
- package/src/contract/private_function_membership_proof.ts +0 -167
- package/src/contract/utility_function_membership_proof.ts +0 -118
package/src/abi/abi.ts
CHANGED
|
@@ -224,7 +224,13 @@ export const FunctionDebugMetadataSchema = z.object({
|
|
|
224
224
|
acir_locations: z.record(z.number()),
|
|
225
225
|
brillig_locations: z.record(z.record(z.number())),
|
|
226
226
|
}),
|
|
227
|
-
files: z.record(
|
|
227
|
+
files: z.record(
|
|
228
|
+
z.object({
|
|
229
|
+
source: z.string(),
|
|
230
|
+
path: z.string(),
|
|
231
|
+
function_locations: z.array(z.object({ start: z.number(), name: z.string() })),
|
|
232
|
+
}),
|
|
233
|
+
),
|
|
228
234
|
}) satisfies z.ZodType<FunctionDebugMetadata>;
|
|
229
235
|
|
|
230
236
|
/** The artifact entry of a function. */
|
|
@@ -305,6 +311,14 @@ export interface ProgramDebugInfo {
|
|
|
305
311
|
debug_infos: Array<DebugInfo>;
|
|
306
312
|
}
|
|
307
313
|
|
|
314
|
+
/** The range a function occupies in a file. */
|
|
315
|
+
export type FunctionLocation = {
|
|
316
|
+
/** The byte where the function starts. */
|
|
317
|
+
start: number;
|
|
318
|
+
/** The name of the function. */
|
|
319
|
+
name: string;
|
|
320
|
+
};
|
|
321
|
+
|
|
308
322
|
/** Maps a file ID to its metadata for debugging purposes. */
|
|
309
323
|
export type DebugFileMap = Record<
|
|
310
324
|
FileId,
|
|
@@ -313,6 +327,8 @@ export type DebugFileMap = Record<
|
|
|
313
327
|
source: string;
|
|
314
328
|
/** The path of the file. */
|
|
315
329
|
path: string;
|
|
330
|
+
/** The range each function occupies in the file. */
|
|
331
|
+
function_locations: FunctionLocation[];
|
|
316
332
|
}
|
|
317
333
|
>;
|
|
318
334
|
|
|
@@ -367,7 +383,14 @@ export const ContractArtifactSchema = zodFor<ContractArtifact>()(
|
|
|
367
383
|
globals: z.record(z.array(AbiValueSchema)),
|
|
368
384
|
}),
|
|
369
385
|
storageLayout: z.record(z.object({ slot: schemas.Fr })),
|
|
370
|
-
fileMap: z.record(
|
|
386
|
+
fileMap: z.record(
|
|
387
|
+
z.coerce.number(),
|
|
388
|
+
z.object({
|
|
389
|
+
source: z.string(),
|
|
390
|
+
path: z.string(),
|
|
391
|
+
function_locations: z.array(z.object({ start: z.number(), name: z.string() })),
|
|
392
|
+
}),
|
|
393
|
+
),
|
|
371
394
|
}),
|
|
372
395
|
);
|
|
373
396
|
|
package/src/abi/buffer.ts
CHANGED
|
@@ -26,11 +26,32 @@ export function bufferAsFields(input: Buffer, targetLength: number): Fr[] {
|
|
|
26
26
|
}
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
|
-
* Recovers a buffer from an array of fields.
|
|
30
|
-
*
|
|
31
|
-
*
|
|
29
|
+
* Recovers a buffer from an array of fields previously encoded with bufferAsFields.
|
|
30
|
+
*
|
|
31
|
+
* The first field encodes the byte length of the original buffer. The remaining fields
|
|
32
|
+
* each carry 31 bytes of payload (the leading byte of each 32-byte field element is skipped).
|
|
33
|
+
*
|
|
34
|
+
* If the declared byte length exceeds the bytes available from the payload fields, the result
|
|
35
|
+
* is zero-padded to the full declared length. This is important for correctness when the field
|
|
36
|
+
* array has been truncated (e.g. contract class logs reconstructed from blobs using a short
|
|
37
|
+
* emittedLength): without padding, the resulting buffer would be shorter than declared, causing
|
|
38
|
+
* bytecode commitment computations to diverge from what the circuit produced.
|
|
39
|
+
*
|
|
40
|
+
* @param fields - An output from bufferAsFields: [byteLength, ...payloadFields].
|
|
41
|
+
* @returns A buffer of exactly `byteLength` bytes.
|
|
32
42
|
*/
|
|
33
43
|
export function bufferFromFields(fields: Fr[]): Buffer {
|
|
34
44
|
const [length, ...payload] = fields;
|
|
35
|
-
|
|
45
|
+
const byteLength = length.toNumber();
|
|
46
|
+
const raw = Buffer.concat(payload.map(f => f.toBuffer().subarray(1)));
|
|
47
|
+
if (raw.length >= byteLength) {
|
|
48
|
+
return raw.subarray(0, byteLength);
|
|
49
|
+
}
|
|
50
|
+
// Pad with zeros if the declared length exceeds the available payload bytes.
|
|
51
|
+
// This ensures the returned buffer always matches the declared length, so that
|
|
52
|
+
// downstream bytecode commitment computations are consistent even when the
|
|
53
|
+
// source field array was truncated (e.g. reconstructed from blob with a short emittedLength).
|
|
54
|
+
const result = Buffer.alloc(byteLength);
|
|
55
|
+
raw.copy(result);
|
|
56
|
+
return result;
|
|
36
57
|
}
|
|
@@ -68,9 +68,8 @@ export interface L2BlockSource {
|
|
|
68
68
|
getCheckpointedL2BlockNumber(): Promise<BlockNumber>;
|
|
69
69
|
|
|
70
70
|
/**
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
* TODO(#13569): Compute proper finalized block number based on L1 finalized block.
|
|
71
|
+
* Returns the finalized L2 block number. A block is finalized when it was proven
|
|
72
|
+
* in an L1 block that has itself been finalized on Ethereum.
|
|
74
73
|
* @returns The finalized block number.
|
|
75
74
|
*/
|
|
76
75
|
getFinalizedL2BlockNumber(): Promise<BlockNumber>;
|
|
@@ -176,14 +175,18 @@ export interface L2BlockSource {
|
|
|
176
175
|
getSettledTxReceipt(txHash: TxHash): Promise<TxReceipt | undefined>;
|
|
177
176
|
|
|
178
177
|
/**
|
|
179
|
-
* Returns the
|
|
178
|
+
* Returns the last L2 slot number for which we have all L1 data needed to build the next checkpoint.
|
|
179
|
+
* Determined by the max of two signals: L1 block sync progress and latest synced checkpoint slot.
|
|
180
|
+
* The checkpoint signal handles missed L1 blocks, since a published checkpoint seals the message tree
|
|
181
|
+
* for the next checkpoint via the inbox LAG mechanism.
|
|
180
182
|
*/
|
|
181
|
-
|
|
183
|
+
getSyncedL2SlotNumber(): Promise<SlotNumber | undefined>;
|
|
182
184
|
|
|
183
185
|
/**
|
|
184
|
-
* Returns the
|
|
186
|
+
* Returns the last L2 epoch number that has been fully synchronized from L1.
|
|
187
|
+
* An epoch is fully synced when all its L2 slots have been fully synced.
|
|
185
188
|
*/
|
|
186
|
-
|
|
189
|
+
getSyncedL2EpochNumber(): Promise<EpochNumber | undefined>;
|
|
187
190
|
|
|
188
191
|
/**
|
|
189
192
|
* Returns all checkpointed block headers for a given epoch.
|
|
@@ -36,7 +36,7 @@ export function validateCheckpoint(
|
|
|
36
36
|
): void {
|
|
37
37
|
validateCheckpointStructure(checkpoint);
|
|
38
38
|
validateCheckpointLimits(checkpoint, opts);
|
|
39
|
-
|
|
39
|
+
validateCheckpointBlocksLimits(checkpoint, opts);
|
|
40
40
|
}
|
|
41
41
|
|
|
42
42
|
/**
|
|
@@ -125,7 +125,7 @@ export function validateCheckpointStructure(checkpoint: Checkpoint): void {
|
|
|
125
125
|
}
|
|
126
126
|
|
|
127
127
|
/** Validates checkpoint blocks gas limits */
|
|
128
|
-
function
|
|
128
|
+
function validateCheckpointBlocksLimits(
|
|
129
129
|
checkpoint: Checkpoint,
|
|
130
130
|
opts: {
|
|
131
131
|
maxL2BlockGas?: number;
|
package/src/config/index.ts
CHANGED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { type ConfigMappingsType, booleanConfigHelper, getConfigFromMappings } from '@aztec/foundation/config';
|
|
2
|
+
|
|
3
|
+
import { z } from 'zod';
|
|
4
|
+
|
|
5
|
+
import { zodFor } from '../schemas/index.js';
|
|
6
|
+
|
|
7
|
+
export type PipelineConfig = {
|
|
8
|
+
/** Whether to enable build-ahead proposer pipelining. */
|
|
9
|
+
enableProposerPipelining: boolean;
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Pipelining config mappings for fields that need to be shared across packages.
|
|
14
|
+
*/
|
|
15
|
+
export const pipelineConfigMappings: ConfigMappingsType<PipelineConfig> = {
|
|
16
|
+
enableProposerPipelining: {
|
|
17
|
+
env: 'SEQ_ENABLE_PROPOSER_PIPELINING',
|
|
18
|
+
description: 'Whether to enable build-ahead proposer pipelining.',
|
|
19
|
+
...booleanConfigHelper(false),
|
|
20
|
+
},
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
export const PipelineConfigSchema = zodFor<PipelineConfig>()(
|
|
24
|
+
z.object({
|
|
25
|
+
enableProposerPipelining: z.boolean(),
|
|
26
|
+
}),
|
|
27
|
+
);
|
|
28
|
+
|
|
29
|
+
export function getPipelineConfigEnvVars(): PipelineConfig {
|
|
30
|
+
return getConfigFromMappings(pipelineConfigMappings);
|
|
31
|
+
}
|
|
@@ -13,9 +13,9 @@ import type { ContractInstance } from './interfaces/contract_instance.js';
|
|
|
13
13
|
/**
|
|
14
14
|
* Returns the deployment address for a given contract instance.
|
|
15
15
|
* ```
|
|
16
|
-
* salted_initialization_hash =
|
|
17
|
-
* partial_address =
|
|
18
|
-
* address = ((
|
|
16
|
+
* salted_initialization_hash = poseidon2(DOM_SEP__PARTIAL_ADDRESS, [salt, initialization_hash, deployer])
|
|
17
|
+
* partial_address = poseidon2(DOM_SEP__PARTIAL_ADDRESS, [contract_class_id, salted_initialization_hash])
|
|
18
|
+
* address = ((poseidon2(DOM_SEP__CONTRACT_ADDRESS_V1, [public_keys_hash, partial_address]) * G) + ivpk_m).x <- the x-coordinate of the address point
|
|
19
19
|
* ```
|
|
20
20
|
* @param instance - A contract instance for which to calculate the deployment address.
|
|
21
21
|
*/
|
|
@@ -13,10 +13,10 @@ import { computePrivateFunctionsRoot } from './private_function.js';
|
|
|
13
13
|
*
|
|
14
14
|
* ```
|
|
15
15
|
* version = 1
|
|
16
|
-
* private_function_leaves = private_functions.map(fn =>
|
|
16
|
+
* private_function_leaves = private_functions.map(fn => poseidon2(DOM_SEP__PRIVATE_FUNCTION_LEAF, [fn.function_selector as Field, fn.vk_hash]))
|
|
17
17
|
* private_functions_root = merkleize(private_function_leaves)
|
|
18
18
|
* bytecode_commitment = calculate_commitment(packed_bytecode)
|
|
19
|
-
* contract_class_id =
|
|
19
|
+
* contract_class_id = poseidon2(DOM_SEP__CONTRACT_CLASS_ID, [version, artifact_hash, private_functions_root, bytecode_commitment])
|
|
20
20
|
* ```
|
|
21
21
|
* @param contractClass - Contract class.
|
|
22
22
|
* @returns The identifier.
|
package/src/contract/index.ts
CHANGED
|
@@ -6,8 +6,6 @@ export * from './contract_deployment_data.js';
|
|
|
6
6
|
export * from './contract_instance.js';
|
|
7
7
|
export * from './contract_instance_update.js';
|
|
8
8
|
export * from './private_function.js';
|
|
9
|
-
export * from './private_function_membership_proof.js';
|
|
10
|
-
export * from './utility_function_membership_proof.js';
|
|
11
9
|
export * from './interfaces/index.js';
|
|
12
10
|
export * from './contract_function_dao.js';
|
|
13
11
|
export * from './partial_address.js';
|
|
@@ -42,79 +42,6 @@ const PrivateFunctionSchema = zodFor<PrivateFunction>()(
|
|
|
42
42
|
}),
|
|
43
43
|
);
|
|
44
44
|
|
|
45
|
-
/** Private function definition with executable bytecode. */
|
|
46
|
-
export interface ExecutablePrivateFunction extends PrivateFunction {
|
|
47
|
-
/** ACIR and Brillig bytecode */
|
|
48
|
-
bytecode: Buffer;
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
const ExecutablePrivateFunctionSchema = zodFor<ExecutablePrivateFunction>()(
|
|
52
|
-
PrivateFunctionSchema.and(z.object({ bytecode: schemas.Buffer })),
|
|
53
|
-
);
|
|
54
|
-
|
|
55
|
-
/** Utility function definition. */
|
|
56
|
-
export interface UtilityFunction {
|
|
57
|
-
/** Selector of the function. Calculated as the hash of the method name and parameters. The specification of this is not enforced by the protocol. */
|
|
58
|
-
selector: FunctionSelector;
|
|
59
|
-
/** Brillig. */
|
|
60
|
-
bytecode: Buffer;
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
const UtilityFunctionSchema = zodFor<UtilityFunction>()(
|
|
64
|
-
z.object({
|
|
65
|
-
selector: FunctionSelector.schema,
|
|
66
|
-
bytecode: schemas.Buffer,
|
|
67
|
-
}),
|
|
68
|
-
);
|
|
69
|
-
|
|
70
|
-
/** Sibling paths and sibling commitments for proving membership of a private function within a contract class. */
|
|
71
|
-
export type PrivateFunctionMembershipProof = {
|
|
72
|
-
artifactMetadataHash: Fr;
|
|
73
|
-
functionMetadataHash: Fr;
|
|
74
|
-
utilityFunctionsTreeRoot: Fr;
|
|
75
|
-
privateFunctionTreeSiblingPath: Fr[];
|
|
76
|
-
privateFunctionTreeLeafIndex: number;
|
|
77
|
-
artifactTreeSiblingPath: Fr[];
|
|
78
|
-
artifactTreeLeafIndex: number;
|
|
79
|
-
};
|
|
80
|
-
|
|
81
|
-
const PrivateFunctionMembershipProofSchema = zodFor<PrivateFunctionMembershipProof>()(
|
|
82
|
-
z.object({
|
|
83
|
-
artifactMetadataHash: schemas.Fr,
|
|
84
|
-
functionMetadataHash: schemas.Fr,
|
|
85
|
-
utilityFunctionsTreeRoot: schemas.Fr,
|
|
86
|
-
privateFunctionTreeSiblingPath: z.array(schemas.Fr),
|
|
87
|
-
privateFunctionTreeLeafIndex: schemas.Integer,
|
|
88
|
-
artifactTreeSiblingPath: z.array(schemas.Fr),
|
|
89
|
-
artifactTreeLeafIndex: schemas.Integer,
|
|
90
|
-
}),
|
|
91
|
-
);
|
|
92
|
-
|
|
93
|
-
/** A private function with a membership proof. */
|
|
94
|
-
export type ExecutablePrivateFunctionWithMembershipProof = ExecutablePrivateFunction & PrivateFunctionMembershipProof;
|
|
95
|
-
|
|
96
|
-
/** Sibling paths and commitments for proving membership of a utility function within a contract class. */
|
|
97
|
-
export type UtilityFunctionMembershipProof = {
|
|
98
|
-
artifactMetadataHash: Fr;
|
|
99
|
-
functionMetadataHash: Fr;
|
|
100
|
-
privateFunctionsArtifactTreeRoot: Fr;
|
|
101
|
-
artifactTreeSiblingPath: Fr[];
|
|
102
|
-
artifactTreeLeafIndex: number;
|
|
103
|
-
};
|
|
104
|
-
|
|
105
|
-
const UtilityFunctionMembershipProofSchema = zodFor<UtilityFunctionMembershipProof>()(
|
|
106
|
-
z.object({
|
|
107
|
-
artifactMetadataHash: schemas.Fr,
|
|
108
|
-
functionMetadataHash: schemas.Fr,
|
|
109
|
-
privateFunctionsArtifactTreeRoot: schemas.Fr,
|
|
110
|
-
artifactTreeSiblingPath: z.array(schemas.Fr),
|
|
111
|
-
artifactTreeLeafIndex: schemas.Integer,
|
|
112
|
-
}),
|
|
113
|
-
);
|
|
114
|
-
|
|
115
|
-
/** A utility function with a membership proof. */
|
|
116
|
-
export type UtilityFunctionWithMembershipProof = UtilityFunction & UtilityFunctionMembershipProof;
|
|
117
|
-
|
|
118
45
|
export const ContractClassSchema = zodFor<ContractClass>()(
|
|
119
46
|
z.object({
|
|
120
47
|
version: z.literal(VERSION),
|
|
@@ -143,11 +70,8 @@ export const ContractClassWithIdSchema = zodFor<ContractClassWithId>()(
|
|
|
143
70
|
}),
|
|
144
71
|
);
|
|
145
72
|
|
|
146
|
-
/** A contract class with public bytecode information
|
|
147
|
-
export type ContractClassPublic =
|
|
148
|
-
privateFunctions: ExecutablePrivateFunctionWithMembershipProof[];
|
|
149
|
-
utilityFunctions: UtilityFunctionWithMembershipProof[];
|
|
150
|
-
} & Pick<ContractClassCommitments, 'id' | 'privateFunctionsRoot'> &
|
|
73
|
+
/** A contract class with public bytecode information. */
|
|
74
|
+
export type ContractClassPublic = Pick<ContractClassCommitments, 'id' | 'privateFunctionsRoot'> &
|
|
151
75
|
Omit<ContractClass, 'privateFunctions'>;
|
|
152
76
|
|
|
153
77
|
export type ContractClassPublicWithCommitment = ContractClassPublic &
|
|
@@ -158,8 +82,6 @@ export const ContractClassPublicSchema = zodFor<ContractClassPublic>()(
|
|
|
158
82
|
.object({
|
|
159
83
|
id: schemas.Fr,
|
|
160
84
|
privateFunctionsRoot: schemas.Fr,
|
|
161
|
-
privateFunctions: z.array(ExecutablePrivateFunctionSchema.and(PrivateFunctionMembershipProofSchema)),
|
|
162
|
-
utilityFunctions: z.array(UtilityFunctionSchema.and(UtilityFunctionMembershipProofSchema)),
|
|
163
85
|
})
|
|
164
86
|
.and(ContractClassSchema.omit({ privateFunctions: true })),
|
|
165
87
|
);
|
|
@@ -179,8 +101,6 @@ export function contractClassPublicFromPlainObject(obj: any): ContractClassPubli
|
|
|
179
101
|
version: 1,
|
|
180
102
|
artifactHash: Fr.fromPlainObject(obj.artifactHash),
|
|
181
103
|
privateFunctionsRoot: Fr.fromPlainObject(obj.privateFunctionsRoot),
|
|
182
|
-
privateFunctions: [],
|
|
183
|
-
utilityFunctions: [],
|
|
184
104
|
packedBytecode: obj.packedBytecode instanceof Buffer ? obj.packedBytecode : Buffer.from(obj.packedBytecode),
|
|
185
105
|
};
|
|
186
106
|
}
|
|
@@ -12,6 +12,7 @@ export type L1RollupConstants = {
|
|
|
12
12
|
ethereumSlotDuration: number;
|
|
13
13
|
proofSubmissionEpochs: number;
|
|
14
14
|
targetCommitteeSize: number;
|
|
15
|
+
rollupManaLimit: number;
|
|
15
16
|
};
|
|
16
17
|
|
|
17
18
|
export const EmptyL1RollupConstants: L1RollupConstants = {
|
|
@@ -22,6 +23,7 @@ export const EmptyL1RollupConstants: L1RollupConstants = {
|
|
|
22
23
|
ethereumSlotDuration: 1,
|
|
23
24
|
proofSubmissionEpochs: 1,
|
|
24
25
|
targetCommitteeSize: 48,
|
|
26
|
+
rollupManaLimit: Number.MAX_SAFE_INTEGER,
|
|
25
27
|
};
|
|
26
28
|
|
|
27
29
|
export const L1RollupConstantsSchema = zodFor<L1RollupConstants>()(
|
|
@@ -33,6 +35,7 @@ export const L1RollupConstantsSchema = zodFor<L1RollupConstants>()(
|
|
|
33
35
|
ethereumSlotDuration: z.number(),
|
|
34
36
|
proofSubmissionEpochs: z.number(),
|
|
35
37
|
targetCommitteeSize: z.number(),
|
|
38
|
+
rollupManaLimit: z.number(),
|
|
36
39
|
}),
|
|
37
40
|
);
|
|
38
41
|
|
|
@@ -54,6 +57,17 @@ export function getSlotAtTimestamp(
|
|
|
54
57
|
: SlotNumber.fromBigInt((ts - constants.l1GenesisTime) / BigInt(constants.slotDuration));
|
|
55
58
|
}
|
|
56
59
|
|
|
60
|
+
/** Returns the timestamp of the next L1 slot boundary after the given wall-clock time. */
|
|
61
|
+
export function getNextL1SlotTimestamp(
|
|
62
|
+
nowInSeconds: number,
|
|
63
|
+
constants: Pick<L1RollupConstants, 'l1GenesisTime' | 'ethereumSlotDuration'>,
|
|
64
|
+
): bigint {
|
|
65
|
+
const now = BigInt(nowInSeconds);
|
|
66
|
+
const elapsed = now - constants.l1GenesisTime;
|
|
67
|
+
const currentL1Slot = elapsed / BigInt(constants.ethereumSlotDuration);
|
|
68
|
+
return constants.l1GenesisTime + (currentL1Slot + 1n) * BigInt(constants.ethereumSlotDuration);
|
|
69
|
+
}
|
|
70
|
+
|
|
57
71
|
/** Returns the L2 slot number at the next L1 block based on the current timestamp. */
|
|
58
72
|
export function getSlotAtNextL1Block(
|
|
59
73
|
currentL1Timestamp: bigint,
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# Aztec Gas and Fee Model
|
|
2
|
+
|
|
3
|
+
The minimum fee per mana and its components are computed on L1 in
|
|
4
|
+
`l1-contracts/src/core/libraries/rollup/FeeLib.sol`. This document describes the
|
|
5
|
+
formulas, the oracle lag/lifetime mechanism, and the TypeScript types in this directory.
|
|
6
|
+
|
|
7
|
+
## Mana
|
|
8
|
+
|
|
9
|
+
Aztec uses **mana** as its unit of work (analogous to Ethereum gas). Transactions consume
|
|
10
|
+
mana in two dimensions: **DA** (data availability) and **L2** (execution). The total fee
|
|
11
|
+
is `gasUsed * feePerMana` summed across both dimensions.
|
|
12
|
+
|
|
13
|
+
## Fee Components
|
|
14
|
+
|
|
15
|
+
The minimum fee per mana has four components:
|
|
16
|
+
|
|
17
|
+
### Sequencer Cost
|
|
18
|
+
|
|
19
|
+
L1 cost to propose a checkpoint (calldata gas + blob data), amortized over `manaTarget`:
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
sequencerCost = ((L1_GAS_PER_CHECKPOINT_PROPOSED * baseFee)
|
|
23
|
+
+ (BLOBS_PER_CHECKPOINT * BLOB_GAS_PER_BLOB * blobFee))
|
|
24
|
+
/ manaTarget
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Prover Cost
|
|
28
|
+
|
|
29
|
+
L1 cost to verify an epoch proof, amortized over epoch duration and `manaTarget`, plus a
|
|
30
|
+
governance-set proving cost that compensates for off-chain proof generation:
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
proverCost = (L1_GAS_PER_EPOCH_VERIFIED * baseFee / epochDuration) / manaTarget
|
|
34
|
+
+ provingCostPerMana
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Congestion Cost
|
|
38
|
+
|
|
39
|
+
An exponential surcharge when the network is congested (inspired by EIP-1559; the
|
|
40
|
+
implementation uses the `fakeExponential` Taylor series approximation from EIP-4844):
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
baseCost = sequencerCost + proverCost
|
|
44
|
+
congestionCost = baseCost * congestionMultiplier / MINIMUM_CONGESTION_MULTIPLIER - baseCost
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
When there is no congestion the multiplier equals `MINIMUM_CONGESTION_MULTIPLIER` (1e9)
|
|
48
|
+
and congestion cost is zero.
|
|
49
|
+
|
|
50
|
+
### Congestion Multiplier
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
excessMana = max(0, prevExcessMana + prevManaUsed - manaTarget)
|
|
54
|
+
congestionMultiplier = fakeExponential(MINIMUM_CONGESTION_MULTIPLIER, excessMana, denominator)
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Each additional `manaTarget` of excess mana increases the multiplier by ~12.5%.
|
|
58
|
+
|
|
59
|
+
### Total
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
minFeePerMana = sequencerCost + proverCost + congestionCost
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## L1 Gas Oracle: Lag and Lifetime
|
|
66
|
+
|
|
67
|
+
The oracle feeds Ethereum's `baseFee` and `blobFee` into the fee model using a two-phase
|
|
68
|
+
(`pre` / `post`) system that smooths out L1 fee volatility.
|
|
69
|
+
|
|
70
|
+
- **LAG = 2 slots** — when new L1 fees are observed, they activate `LAG` slots later
|
|
71
|
+
(`slotOfChange = currentSlot + LAG`). This gives mempool transactions time to land
|
|
72
|
+
before fees change.
|
|
73
|
+
- **LIFETIME = 5 slots** — after an oracle update, the next update is rejected until
|
|
74
|
+
`slotOfChange + (LIFETIME - LAG)` = 3 more slots have passed. This rate-limits how
|
|
75
|
+
frequently L1 fee data can change.
|
|
76
|
+
|
|
77
|
+
Fee resolution at a given timestamp:
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
if slot < slotOfChange → use pre (old fees)
|
|
81
|
+
else → use post (new fees)
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
**Net effect**: L1 fee changes reach L2 with a 2-slot delay and can update at most once
|
|
85
|
+
every 5 slots.
|
|
86
|
+
|
|
87
|
+
## Fee Asset Price
|
|
88
|
+
|
|
89
|
+
Fees are computed in ETH internally but converted to the fee asset (Fee Juice) via
|
|
90
|
+
`ethPerFeeAsset` (1e12 precision). The price updates at most ±1% (±100 bps) per
|
|
91
|
+
checkpoint:
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
newPrice = currentPrice * (10000 + modifierBps) / 10000
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Maximum Fee Change Rate
|
|
98
|
+
|
|
99
|
+
| Component | Bound |
|
|
100
|
+
| ---------------------- | ------------------------------------------------------- |
|
|
101
|
+
| L1 base fee / blob fee | At most once every 5 slots (oracle LIFETIME) |
|
|
102
|
+
| Fee asset price | ±1% per checkpoint |
|
|
103
|
+
| Congestion multiplier | Depends on excess mana accumulation/drain per checkpoint |
|
|
104
|
+
| Sequencer/prover costs | Scale linearly with L1 fees |
|
|
105
|
+
|
|
106
|
+
## Key Constants
|
|
107
|
+
|
|
108
|
+
| Constant | Value |
|
|
109
|
+
| ------------------------------ | -------------- |
|
|
110
|
+
| `L1_GAS_PER_CHECKPOINT_PROPOSED` | 300,000 |
|
|
111
|
+
| `L1_GAS_PER_EPOCH_VERIFIED` | 3,600,000 |
|
|
112
|
+
| `BLOBS_PER_CHECKPOINT` | 3 |
|
|
113
|
+
| `BLOB_GAS_PER_BLOB` | 2^17 |
|
|
114
|
+
| `MINIMUM_CONGESTION_MULTIPLIER` | 1e9 |
|
|
115
|
+
| `LAG` | 2 slots |
|
|
116
|
+
| `LIFETIME` | 5 slots |
|
|
117
|
+
|
|
118
|
+
## TypeScript Types
|
|
119
|
+
|
|
120
|
+
- **`Gas`** — mana quantity in two dimensions (`daGas`, `l2Gas`).
|
|
121
|
+
- **`GasFees`** — per-unit price in each dimension (`feePerDaGas`, `feePerL2Gas`).
|
|
122
|
+
- **`GasSettings`** — sender-chosen fee parameters: gas limits, teardown limits, max fees, priority fees.
|
|
123
|
+
- **`GasUsed`** — actual consumption after execution. Note: `billedGas` uses the teardown gas *limit*, not actual usage.
|
package/src/hash/hash.ts
CHANGED
|
@@ -58,6 +58,35 @@ export function siloNullifier(contract: AztecAddress, innerNullifier: Fr): Promi
|
|
|
58
58
|
return poseidon2HashWithSeparator([contract, innerNullifier], DomainSeparator.SILOED_NULLIFIER);
|
|
59
59
|
}
|
|
60
60
|
|
|
61
|
+
/**
|
|
62
|
+
* Computes the siloed private initialization nullifier for a contract, given its address and initialization hash.
|
|
63
|
+
* @param contract - The contract address.
|
|
64
|
+
* @param initializationHash - The contract's initialization hash.
|
|
65
|
+
* @returns The siloed private initialization nullifier.
|
|
66
|
+
*/
|
|
67
|
+
export async function computeSiloedPrivateInitializationNullifier(
|
|
68
|
+
contract: AztecAddress,
|
|
69
|
+
initializationHash: Fr,
|
|
70
|
+
): Promise<Fr> {
|
|
71
|
+
const innerNullifier = await poseidon2HashWithSeparator(
|
|
72
|
+
[contract, initializationHash],
|
|
73
|
+
DomainSeparator.PRIVATE_INITIALIZATION_NULLIFIER,
|
|
74
|
+
);
|
|
75
|
+
return siloNullifier(contract, innerNullifier);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Computes the siloed public initialization nullifier for a contract. Not all contracts emit this nullifier: it is only
|
|
80
|
+
* emitted when the contract has public functions that perform initialization checks (i.e. external public functions that
|
|
81
|
+
* are not `#[noinitcheck]` or `#[only_self]`).
|
|
82
|
+
* @param contract - The contract address.
|
|
83
|
+
* @returns The siloed public initialization nullifier.
|
|
84
|
+
*/
|
|
85
|
+
export async function computeSiloedPublicInitializationNullifier(contract: AztecAddress): Promise<Fr> {
|
|
86
|
+
const innerNullifier = await poseidon2HashWithSeparator([contract], DomainSeparator.PUBLIC_INITIALIZATION_NULLIFIER);
|
|
87
|
+
return siloNullifier(contract, innerNullifier);
|
|
88
|
+
}
|
|
89
|
+
|
|
61
90
|
/**
|
|
62
91
|
* Computes the protocol nullifier, which is the hash of the initial tx request siloed with the null msg sender address.
|
|
63
92
|
* @param txRequestHash - The hash of the initial tx request.
|
|
@@ -114,8 +114,8 @@ export const ArchiverApiSchema: ApiSchemaFor<ArchiverApi> = {
|
|
|
114
114
|
getL2BlockByArchive: z.function().args(schemas.Fr).returns(L2Block.schema.optional()),
|
|
115
115
|
getTxEffect: z.function().args(TxHash.schema).returns(indexedTxSchema().optional()),
|
|
116
116
|
getSettledTxReceipt: z.function().args(TxHash.schema).returns(TxReceipt.schema.optional()),
|
|
117
|
-
|
|
118
|
-
|
|
117
|
+
getSyncedL2SlotNumber: z.function().args().returns(schemas.SlotNumber.optional()),
|
|
118
|
+
getSyncedL2EpochNumber: z.function().args().returns(EpochNumberSchema.optional()),
|
|
119
119
|
getCheckpointsForEpoch: z.function().args(EpochNumberSchema).returns(z.array(Checkpoint.schema)),
|
|
120
120
|
getCheckpointsDataForEpoch: z.function().args(EpochNumberSchema).returns(z.array(CheckpointDataSchema)),
|
|
121
121
|
getCheckpointedBlocksForEpoch: z.function().args(EpochNumberSchema).returns(z.array(CheckpointedL2Block.schema)),
|
|
@@ -25,6 +25,7 @@ import { CheckpointedL2Block } from '../block/checkpointed_l2_block.js';
|
|
|
25
25
|
import { type DataInBlock, dataInBlockSchemaFor } from '../block/in_block.js';
|
|
26
26
|
import { L2Block } from '../block/l2_block.js';
|
|
27
27
|
import { type L2BlockSource, type L2Tips, L2TipsSchema } from '../block/l2_block_source.js';
|
|
28
|
+
import { CheckpointDataSchema } from '../checkpoint/checkpoint_data.js';
|
|
28
29
|
import { PublishedCheckpoint } from '../checkpoint/published_checkpoint.js';
|
|
29
30
|
import {
|
|
30
31
|
type ContractClassPublic,
|
|
@@ -74,7 +75,12 @@ import { type WorldStateSyncStatus, WorldStateSyncStatusSchema } from './world_s
|
|
|
74
75
|
export interface AztecNode
|
|
75
76
|
extends Pick<
|
|
76
77
|
L2BlockSource,
|
|
77
|
-
|
|
78
|
+
| 'getBlocks'
|
|
79
|
+
| 'getCheckpoints'
|
|
80
|
+
| 'getBlockHeader'
|
|
81
|
+
| 'getL2Tips'
|
|
82
|
+
| 'getCheckpointedBlocks'
|
|
83
|
+
| 'getCheckpointsDataForEpoch'
|
|
78
84
|
> {
|
|
79
85
|
/**
|
|
80
86
|
* Returns the tips of the L2 chain.
|
|
@@ -116,6 +122,7 @@ export interface AztecNode
|
|
|
116
122
|
* @param referenceBlock - The block parameter (block number, block hash, or 'latest') at which to get the data.
|
|
117
123
|
* @param nullifier - Nullifier we try to find the low nullifier witness for.
|
|
118
124
|
* @returns The low nullifier membership witness (if found).
|
|
125
|
+
* @throws If the nullifier already exists in the tree, since non-inclusion cannot be proven.
|
|
119
126
|
* @remarks Low nullifier witness can be used to perform a nullifier non-inclusion proof by leveraging the "linked
|
|
120
127
|
* list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
|
|
121
128
|
* we are trying to prove non-inclusion for.
|
|
@@ -567,6 +574,8 @@ export const AztecNodeApiSchema: ApiSchemaFor<AztecNode> = {
|
|
|
567
574
|
.args(BlockNumberPositiveSchema, z.number().gt(0).lte(MAX_RPC_BLOCKS_LEN))
|
|
568
575
|
.returns(z.array(CheckpointedL2Block.schema)),
|
|
569
576
|
|
|
577
|
+
getCheckpointsDataForEpoch: z.function().args(EpochNumberSchema).returns(z.array(CheckpointDataSchema)),
|
|
578
|
+
|
|
570
579
|
getCurrentMinFees: z.function().returns(GasFees.schema),
|
|
571
580
|
|
|
572
581
|
getMaxPriorityFees: z.function().returns(GasFees.schema),
|