@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.
Files changed (148) hide show
  1. package/dest/abi/abi.d.ts +138 -1
  2. package/dest/abi/abi.d.ts.map +1 -1
  3. package/dest/abi/abi.js +10 -2
  4. package/dest/abi/buffer.d.ts +14 -4
  5. package/dest/abi/buffer.d.ts.map +1 -1
  6. package/dest/abi/buffer.js +25 -4
  7. package/dest/avm/avm.d.ts +300 -300
  8. package/dest/block/l2_block_source.d.ts +11 -8
  9. package/dest/block/l2_block_source.d.ts.map +1 -1
  10. package/dest/checkpoint/validate.js +2 -2
  11. package/dest/config/index.d.ts +2 -1
  12. package/dest/config/index.d.ts.map +1 -1
  13. package/dest/config/index.js +1 -0
  14. package/dest/config/pipelining-config.d.ts +19 -0
  15. package/dest/config/pipelining-config.d.ts.map +1 -0
  16. package/dest/config/pipelining-config.js +18 -0
  17. package/dest/contract/contract_address.d.ts +3 -3
  18. package/dest/contract/contract_address.js +3 -3
  19. package/dest/contract/contract_class_id.d.ts +2 -2
  20. package/dest/contract/contract_class_id.js +2 -2
  21. package/dest/contract/index.d.ts +1 -3
  22. package/dest/contract/index.d.ts.map +1 -1
  23. package/dest/contract/index.js +0 -2
  24. package/dest/contract/interfaces/contract_class.d.ts +3 -156
  25. package/dest/contract/interfaces/contract_class.d.ts.map +1 -1
  26. package/dest/contract/interfaces/contract_class.js +1 -28
  27. package/dest/epoch-helpers/index.d.ts +7 -1
  28. package/dest/epoch-helpers/index.d.ts.map +1 -1
  29. package/dest/epoch-helpers/index.js +10 -2
  30. package/dest/hash/hash.d.ts +16 -1
  31. package/dest/hash/hash.d.ts.map +1 -1
  32. package/dest/hash/hash.js +24 -0
  33. package/dest/interfaces/archiver.js +2 -2
  34. package/dest/interfaces/aztec-node-admin.d.ts +7 -1
  35. package/dest/interfaces/aztec-node-admin.d.ts.map +1 -1
  36. package/dest/interfaces/aztec-node.d.ts +3 -2
  37. package/dest/interfaces/aztec-node.d.ts.map +1 -1
  38. package/dest/interfaces/aztec-node.js +2 -0
  39. package/dest/interfaces/block-builder.d.ts +32 -11
  40. package/dest/interfaces/block-builder.d.ts.map +1 -1
  41. package/dest/interfaces/block-builder.js +6 -4
  42. package/dest/interfaces/configs.d.ts +7 -2
  43. package/dest/interfaces/configs.d.ts.map +1 -1
  44. package/dest/interfaces/configs.js +1 -0
  45. package/dest/interfaces/l2_logs_source.d.ts +5 -3
  46. package/dest/interfaces/l2_logs_source.d.ts.map +1 -1
  47. package/dest/interfaces/merkle_tree_operations.d.ts +9 -19
  48. package/dest/interfaces/merkle_tree_operations.d.ts.map +1 -1
  49. package/dest/interfaces/prover-client.d.ts +6 -1
  50. package/dest/interfaces/prover-client.d.ts.map +1 -1
  51. package/dest/interfaces/prover-client.js +7 -1
  52. package/dest/interfaces/proving-job.d.ts +200 -200
  53. package/dest/interfaces/world_state.d.ts +5 -4
  54. package/dest/interfaces/world_state.d.ts.map +1 -1
  55. package/dest/logs/index.d.ts +2 -1
  56. package/dest/logs/index.d.ts.map +1 -1
  57. package/dest/logs/index.js +1 -0
  58. package/dest/logs/log_filter.d.ts +4 -1
  59. package/dest/logs/log_filter.d.ts.map +1 -1
  60. package/dest/logs/log_filter.js +2 -1
  61. package/dest/logs/tagging_index_range.d.ts +40 -0
  62. package/dest/logs/tagging_index_range.d.ts.map +1 -0
  63. package/dest/logs/tagging_index_range.js +8 -0
  64. package/dest/logs/tx_scoped_l2_log.d.ts +3 -1
  65. package/dest/logs/tx_scoped_l2_log.d.ts.map +1 -1
  66. package/dest/logs/tx_scoped_l2_log.js +7 -0
  67. package/dest/messaging/l1_to_l2_message_source.d.ts +4 -2
  68. package/dest/messaging/l1_to_l2_message_source.d.ts.map +1 -1
  69. package/dest/messaging/l2_to_l1_membership.d.ts +32 -6
  70. package/dest/messaging/l2_to_l1_membership.d.ts.map +1 -1
  71. package/dest/messaging/l2_to_l1_membership.js +69 -26
  72. package/dest/noir/index.d.ts +3 -3
  73. package/dest/noir/index.d.ts.map +1 -1
  74. package/dest/p2p/checkpoint_proposal.d.ts +1 -1
  75. package/dest/p2p/checkpoint_proposal.d.ts.map +1 -1
  76. package/dest/p2p/checkpoint_proposal.js +13 -11
  77. package/dest/tests/factories.d.ts +2 -4
  78. package/dest/tests/factories.d.ts.map +1 -1
  79. package/dest/tests/factories.js +0 -27
  80. package/dest/tx/private_execution_result.d.ts +6 -6
  81. package/dest/tx/private_execution_result.d.ts.map +1 -1
  82. package/dest/tx/private_execution_result.js +6 -6
  83. package/dest/tx/profiling.d.ts +14 -2
  84. package/dest/tx/profiling.d.ts.map +1 -1
  85. package/dest/tx/profiling.js +13 -3
  86. package/dest/tx/simulated_tx.d.ts +109 -1
  87. package/dest/tx/simulated_tx.d.ts.map +1 -1
  88. package/dest/tx/tx_receipt.d.ts +7 -2
  89. package/dest/tx/tx_receipt.d.ts.map +1 -1
  90. package/dest/tx/tx_receipt.js +6 -3
  91. package/dest/tx/validator/error_texts.d.ts +5 -1
  92. package/dest/tx/validator/error_texts.d.ts.map +1 -1
  93. package/dest/tx/validator/error_texts.js +6 -0
  94. package/dest/update-checker/package_version.d.ts +2 -2
  95. package/dest/update-checker/package_version.d.ts.map +1 -1
  96. package/dest/update-checker/package_version.js +16 -3
  97. package/dest/validators/errors.d.ts +6 -1
  98. package/dest/validators/errors.d.ts.map +1 -1
  99. package/dest/validators/errors.js +7 -0
  100. package/dest/versioning/versioning.d.ts +4 -2
  101. package/dest/versioning/versioning.d.ts.map +1 -1
  102. package/dest/versioning/versioning.js +4 -1
  103. package/package.json +8 -8
  104. package/src/abi/abi.ts +25 -2
  105. package/src/abi/buffer.ts +25 -4
  106. package/src/block/l2_block_source.ts +10 -7
  107. package/src/checkpoint/validate.ts +2 -2
  108. package/src/config/index.ts +1 -0
  109. package/src/config/pipelining-config.ts +31 -0
  110. package/src/contract/contract_address.ts +3 -3
  111. package/src/contract/contract_class_id.ts +2 -2
  112. package/src/contract/index.ts +0 -2
  113. package/src/contract/interfaces/contract_class.ts +2 -82
  114. package/src/epoch-helpers/index.ts +14 -0
  115. package/src/gas/README.md +123 -0
  116. package/src/hash/hash.ts +29 -0
  117. package/src/interfaces/archiver.ts +2 -2
  118. package/src/interfaces/aztec-node.ts +10 -1
  119. package/src/interfaces/block-builder.ts +39 -13
  120. package/src/interfaces/configs.ts +4 -1
  121. package/src/interfaces/l2_logs_source.ts +4 -1
  122. package/src/interfaces/merkle_tree_operations.ts +8 -18
  123. package/src/interfaces/prover-client.ts +8 -0
  124. package/src/interfaces/world_state.ts +4 -3
  125. package/src/logs/index.ts +1 -0
  126. package/src/logs/log_filter.ts +5 -0
  127. package/src/logs/tagging_index_range.ts +24 -0
  128. package/src/logs/tx_scoped_l2_log.ts +16 -0
  129. package/src/messaging/l1_to_l2_message_source.ts +3 -1
  130. package/src/messaging/l2_to_l1_membership.ts +98 -33
  131. package/src/noir/index.ts +2 -2
  132. package/src/p2p/checkpoint_proposal.ts +23 -20
  133. package/src/tests/factories.ts +0 -33
  134. package/src/tx/private_execution_result.ts +5 -5
  135. package/src/tx/profiling.ts +11 -2
  136. package/src/tx/tx_receipt.ts +7 -2
  137. package/src/tx/validator/error_texts.ts +8 -0
  138. package/src/update-checker/package_version.ts +19 -6
  139. package/src/validators/errors.ts +9 -0
  140. package/src/versioning/versioning.ts +4 -1
  141. package/dest/contract/private_function_membership_proof.d.ts +0 -32
  142. package/dest/contract/private_function_membership_proof.d.ts.map +0 -1
  143. package/dest/contract/private_function_membership_proof.js +0 -124
  144. package/dest/contract/utility_function_membership_proof.d.ts +0 -27
  145. package/dest/contract/utility_function_membership_proof.d.ts.map +0 -1
  146. package/dest/contract/utility_function_membership_proof.js +0 -87
  147. package/src/contract/private_function_membership_proof.ts +0 -167
  148. package/src/contract/utility_function_membership_proof.ts +0 -118
@@ -11,7 +11,7 @@ import { PrivateCircuitPublicInputs } from '../kernel/private_circuit_public_inp
11
11
  import type { IsEmpty } from '../kernel/utils/interfaces.js';
12
12
  import { sortByCounter } from '../kernel/utils/order_and_comparison.js';
13
13
  import { ContractClassLog, ContractClassLogFields } from '../logs/contract_class_log.js';
14
- import { type PreTag, PreTagSchema } from '../logs/pre_tag.js';
14
+ import { type TaggingIndexRange, TaggingIndexRangeSchema } from '../logs/tagging_index_range.js';
15
15
  import { Note } from '../note/note.js';
16
16
  import { type ZodFor, mapSchema, schemas } from '../schemas/index.js';
17
17
  import { HashedValues } from './hashed_values.js';
@@ -137,8 +137,8 @@ export class PrivateCallExecutionResult {
137
137
  public returnValues: Fr[],
138
138
  /** The offchain effects emitted during execution of this function call via the `emit_offchain_effect` oracle. */
139
139
  public offchainEffects: { data: Fr[] }[],
140
- /** The pre-tags used in this tx to compute tags for private logs */
141
- public preTags: PreTag[],
140
+ /** The tagging index ranges used in this tx to compute tags for private logs */
141
+ public taggingIndexRanges: TaggingIndexRange[],
142
142
  /** The nested executions. */
143
143
  public nestedExecutionResults: PrivateCallExecutionResult[],
144
144
  /**
@@ -161,7 +161,7 @@ export class PrivateCallExecutionResult {
161
161
  noteHashNullifierCounterMap: mapSchema(z.coerce.number(), z.number()),
162
162
  returnValues: z.array(schemas.Fr),
163
163
  offchainEffects: z.array(z.object({ data: z.array(schemas.Fr) })),
164
- preTags: z.array(PreTagSchema),
164
+ taggingIndexRanges: z.array(TaggingIndexRangeSchema),
165
165
  nestedExecutionResults: z.array(z.lazy(() => PrivateCallExecutionResult.schema)),
166
166
  contractClassLogs: z.array(CountedContractClassLog.schema),
167
167
  })
@@ -178,7 +178,7 @@ export class PrivateCallExecutionResult {
178
178
  fields.noteHashNullifierCounterMap,
179
179
  fields.returnValues,
180
180
  fields.offchainEffects,
181
- fields.preTags,
181
+ fields.taggingIndexRanges,
182
182
  fields.nestedExecutionResults,
183
183
  fields.contractClassLogs,
184
184
  );
@@ -3,6 +3,7 @@ import { type ZodFor, optional, schemas } from '@aztec/foundation/schemas';
3
3
 
4
4
  import { z } from 'zod';
5
5
 
6
+ import { AztecAddress } from '../aztec-address/index.js';
6
7
  import type { AztecNode } from '../interfaces/aztec-node.js';
7
8
  import { type PrivateExecutionStep, PrivateExecutionStepSchema } from '../kernel/private_kernel_prover_output.js';
8
9
 
@@ -160,6 +161,9 @@ export class TxProfileResult {
160
161
  export class UtilityExecutionResult {
161
162
  constructor(
162
163
  public result: Fr[],
164
+ public offchainEffects: { data: Fr[]; contractAddress: AztecAddress }[],
165
+ /** Timestamp of the anchor block used during utility execution. */
166
+ public anchorBlockTimestamp: bigint,
163
167
  public stats?: SimulationStats,
164
168
  ) {}
165
169
 
@@ -167,13 +171,18 @@ export class UtilityExecutionResult {
167
171
  return z
168
172
  .object({
169
173
  result: z.array(schemas.Fr),
174
+ offchainEffects: z.array(z.object({ data: z.array(schemas.Fr), contractAddress: AztecAddress.schema })),
175
+ anchorBlockTimestamp: schemas.BigInt,
170
176
  stats: optional(SimulationStatsSchema),
171
177
  })
172
- .transform(({ result, stats }) => new UtilityExecutionResult(result, stats));
178
+ .transform(
179
+ ({ result, offchainEffects, anchorBlockTimestamp, stats }) =>
180
+ new UtilityExecutionResult(result, offchainEffects, anchorBlockTimestamp, stats),
181
+ );
173
182
  }
174
183
 
175
184
  static random(): UtilityExecutionResult {
176
- return new UtilityExecutionResult([Fr.random()], {
185
+ return new UtilityExecutionResult([Fr.random()], [], 0n, {
177
186
  nodeRPCCalls: {
178
187
  perMethod: { getBlockHeader: { times: [1] } },
179
188
  roundTrips: {
@@ -1,4 +1,4 @@
1
- import { BlockNumber, BlockNumberSchema } from '@aztec/foundation/branded-types';
1
+ import { BlockNumber, BlockNumberSchema, EpochNumber, EpochNumberSchema } from '@aztec/foundation/branded-types';
2
2
 
3
3
  import { z } from 'zod';
4
4
 
@@ -15,7 +15,7 @@ export enum TxStatus {
15
15
  PROPOSED = 'proposed',
16
16
  CHECKPOINTED = 'checkpointed',
17
17
  PROVEN = 'proven',
18
- FINALIZED = 'finalized', // TODO(#13569): Implement finalized status properly
18
+ FINALIZED = 'finalized',
19
19
  }
20
20
 
21
21
  /** Tx status sorted by finalization progress. */
@@ -58,6 +58,8 @@ export class TxReceipt {
58
58
  public blockHash?: BlockHash,
59
59
  /** The block number in which the transaction was included. */
60
60
  public blockNumber?: BlockNumber,
61
+ /** The epoch number in which the transaction was included. */
62
+ public epochNumber?: EpochNumber,
61
63
  /**
62
64
  * Debug logs collected during public function execution. Served only when the node is in test mode and placed on
63
65
  * the receipt only because it's a convenient place for it (the logs are printed out by the wallet when a mined
@@ -109,6 +111,7 @@ export class TxReceipt {
109
111
  error: z.string().optional(),
110
112
  blockHash: BlockHash.schema.optional(),
111
113
  blockNumber: BlockNumberSchema.optional(),
114
+ epochNumber: EpochNumberSchema.optional(),
112
115
  transactionFee: schemas.BigInt.optional(),
113
116
  debugLogs: z.array(DebugLog.schema).optional(),
114
117
  })
@@ -123,6 +126,7 @@ export class TxReceipt {
123
126
  transactionFee?: bigint;
124
127
  blockHash?: BlockHash;
125
128
  blockNumber?: BlockNumber;
129
+ epochNumber?: EpochNumber;
126
130
  debugLogs?: DebugLog[];
127
131
  }) {
128
132
  return new TxReceipt(
@@ -133,6 +137,7 @@ export class TxReceipt {
133
137
  fields.transactionFee,
134
138
  fields.blockHash,
135
139
  fields.blockNumber,
140
+ fields.epochNumber,
136
141
  fields.debugLogs,
137
142
  );
138
143
  }
@@ -41,5 +41,13 @@ export const TX_ERROR_SIZE_ABOVE_LIMIT = 'Transaction size above size limit';
41
41
  // Block header
42
42
  export const TX_ERROR_BLOCK_HEADER = 'Block header not found';
43
43
 
44
+ // Contract instance
45
+ export const TX_ERROR_INCORRECT_CONTRACT_ADDRESS = 'Incorrect contract instance deployment address';
46
+ export const TX_ERROR_MALFORMED_CONTRACT_INSTANCE_LOG = 'Failed to parse contract instance deployment log';
47
+
48
+ // Contract class
49
+ export const TX_ERROR_INCORRECT_CONTRACT_CLASS_ID = 'Incorrect contract class id';
50
+ export const TX_ERROR_MALFORMED_CONTRACT_CLASS_LOG = 'Failed to parse contract class registration log';
51
+
44
52
  // General
45
53
  export const TX_ERROR_DURING_VALIDATION = 'Unexpected error during validation';
@@ -3,15 +3,28 @@ import { fileURLToPath } from '@aztec/foundation/url';
3
3
  import { readFileSync } from 'fs';
4
4
  import { dirname, resolve } from 'path';
5
5
 
6
- /** Returns the package version from the release-please manifest, or undefined if not found. */
6
+ /** Returns the package version from the release-please manifest or the package.json, or undefined if not found. */
7
7
  export function getPackageVersion(): string | undefined {
8
+ const dir = dirname(fileURLToPath(import.meta.url));
9
+
10
+ // Try the release-please manifest first (works in dev/repo checkout).
8
11
  try {
9
- const releasePleaseManifestPath = resolve(
10
- dirname(fileURLToPath(import.meta.url)),
11
- '../../../../.release-please-manifest.json',
12
- );
12
+ const releasePleaseManifestPath = resolve(dir, '../../../../.release-please-manifest.json');
13
13
  return JSON.parse(readFileSync(releasePleaseManifestPath).toString())['.'];
14
14
  } catch {
15
- return undefined;
15
+ // Not in a repo checkout, fall through.
16
+ }
17
+
18
+ // Fall back to the stdlib package.json version (works in npm-installed packages).
19
+ try {
20
+ const packageJsonPath = resolve(dir, '../../package.json');
21
+ const version = JSON.parse(readFileSync(packageJsonPath).toString()).version;
22
+ if (version && version !== '0.1.0') {
23
+ return version;
24
+ }
25
+ } catch {
26
+ // No package.json found either.
16
27
  }
28
+
29
+ return undefined;
17
30
  }
@@ -36,6 +36,15 @@ export class FailedToReExecuteTransactionsError extends ValidatorError {
36
36
  }
37
37
  }
38
38
 
39
+ export class ReExInitialStateMismatchError extends ValidatorError {
40
+ constructor(
41
+ public readonly expectedArchiveRoot: Fr,
42
+ public readonly actualArchiveRoot: Fr,
43
+ ) {
44
+ super('Re-execution initial state mismatch');
45
+ }
46
+ }
47
+
39
48
  export class ReExStateMismatchError extends ValidatorError {
40
49
  constructor(
41
50
  public readonly expectedArchiveRoot: Fr,
@@ -115,7 +115,7 @@ export function validatePartialComponentVersionsMatch(
115
115
  }
116
116
 
117
117
  /** Returns a Koa middleware that injects the versioning info as headers. */
118
- export function getVersioningMiddleware(versions: Partial<ComponentsVersions>) {
118
+ export function getVersioningMiddleware(versions: Partial<ComponentsVersions>, opts?: { packageVersion?: string }) {
119
119
  return async (ctx: Koa.Context, next: () => Promise<void>) => {
120
120
  try {
121
121
  await next();
@@ -128,6 +128,9 @@ export function getVersioningMiddleware(versions: Partial<ComponentsVersions>) {
128
128
  ctx.set(`x-aztec-${key}`, value.toString());
129
129
  }
130
130
  }
131
+ if (opts?.packageVersion) {
132
+ ctx.set('x-aztec-packageVersion', opts.packageVersion);
133
+ }
131
134
  }
132
135
  };
133
136
  }
@@ -1,32 +0,0 @@
1
- import { type ContractArtifact, FunctionSelector } from '../abi/index.js';
2
- import type { ContractClassPublic, ExecutablePrivateFunctionWithMembershipProof, PrivateFunctionMembershipProof } from './interfaces/index.js';
3
- /**
4
- * Creates a membership proof for a private function in a contract class, to be verified via `isValidPrivateFunctionMembershipProof`.
5
- * @param selector - Selector of the function to create the proof for.
6
- * @param artifact - Artifact of the contract class where the function is defined.
7
- */
8
- export declare function createPrivateFunctionMembershipProof(selector: FunctionSelector, artifact: ContractArtifact): Promise<PrivateFunctionMembershipProof>;
9
- /**
10
- * Verifies that a private function with a membership proof as emitted by the ClassRegistry contract is valid,
11
- * as defined in the protocol specs at contract-deployment/classes:
12
- *
13
- * ```
14
- * // Load contract class from local db
15
- * contract_class = db.get_contract_class(contract_class_id)
16
- *
17
- * // Compute function leaf and assert it belongs to the private functions tree
18
- * function_leaf = pedersen([selector as Field, vk_hash], GENERATOR__PRIVATE_FUNCTION_LEAF)
19
- * computed_private_function_tree_root = compute_root(function_leaf, private_function_tree_sibling_path)
20
- * assert computed_private_function_tree_root == contract_class.private_functions_root
21
- *
22
- * // Compute artifact leaf and assert it belongs to the artifact
23
- * artifact_function_leaf = sha256(selector, metadata_hash, sha256(bytecode))
24
- * computed_artifact_private_function_tree_root = compute_root(artifact_function_leaf, artifact_function_tree_sibling_path)
25
- * computed_artifact_hash = sha256(computed_artifact_private_function_tree_root, utility_functions_artifact_tree_root, artifact_metadata_hash)
26
- * assert computed_artifact_hash == contract_class.artifact_hash
27
- * ```
28
- * @param fn - Function to check membership proof for.
29
- * @param contractClass - In which contract class the function is expected to be.
30
- */
31
- export declare function isValidPrivateFunctionMembershipProof(fn: ExecutablePrivateFunctionWithMembershipProof, contractClass: Pick<ContractClassPublic, 'privateFunctionsRoot' | 'artifactHash'>): Promise<boolean>;
32
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJpdmF0ZV9mdW5jdGlvbl9tZW1iZXJzaGlwX3Byb29mLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29udHJhY3QvcHJpdmF0ZV9mdW5jdGlvbl9tZW1iZXJzaGlwX3Byb29mLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUtBLE9BQU8sRUFBRSxLQUFLLGdCQUFnQixFQUFFLGdCQUFnQixFQUFnQixNQUFNLGlCQUFpQixDQUFDO0FBVXhGLE9BQU8sS0FBSyxFQUNWLG1CQUFtQixFQUNuQiw0Q0FBNEMsRUFDNUMsOEJBQThCLEVBQy9CLE1BQU0sdUJBQXVCLENBQUM7QUFHL0I7Ozs7R0FJRztBQUNILHdCQUFzQixvQ0FBb0MsQ0FDeEQsUUFBUSxFQUFFLGdCQUFnQixFQUMxQixRQUFRLEVBQUUsZ0JBQWdCLEdBQ3pCLE9BQU8sQ0FBQyw4QkFBOEIsQ0FBQyxDQTREekM7QUFFRDs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBcUJHO0FBQ0gsd0JBQXNCLHFDQUFxQyxDQUN6RCxFQUFFLEVBQUUsNENBQTRDLEVBQ2hELGFBQWEsRUFBRSxJQUFJLENBQUMsbUJBQW1CLEVBQUUsc0JBQXNCLEdBQUcsY0FBYyxDQUFDLG9CQWtEbEYifQ==
@@ -1 +0,0 @@
1
- {"version":3,"file":"private_function_membership_proof.d.ts","sourceRoot":"","sources":["../../src/contract/private_function_membership_proof.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,gBAAgB,EAAE,gBAAgB,EAAgB,MAAM,iBAAiB,CAAC;AAUxF,OAAO,KAAK,EACV,mBAAmB,EACnB,4CAA4C,EAC5C,8BAA8B,EAC/B,MAAM,uBAAuB,CAAC;AAG/B;;;;GAIG;AACH,wBAAsB,oCAAoC,CACxD,QAAQ,EAAE,gBAAgB,EAC1B,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,8BAA8B,CAAC,CA4DzC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,qCAAqC,CACzD,EAAE,EAAE,4CAA4C,EAChD,aAAa,EAAE,IAAI,CAAC,mBAAmB,EAAE,sBAAsB,GAAG,cAAc,CAAC,oBAkDlF"}
@@ -1,124 +0,0 @@
1
- import { poseidon2Hash } from '@aztec/foundation/crypto/poseidon';
2
- import { Fr } from '@aztec/foundation/curves/bn254';
3
- import { createLogger } from '@aztec/foundation/log';
4
- import { computeRootFromSiblingPath } from '@aztec/foundation/trees';
5
- import { FunctionSelector, FunctionType } from '../abi/index.js';
6
- import { computeArtifactFunctionTree, computeArtifactHash, computeArtifactHashPreimage, computeFunctionArtifactHash, computeFunctionMetadataHash, getArtifactMerkleTreeHasher } from './artifact_hash.js';
7
- import { getContractClassPrivateFunctionFromArtifact } from './contract_class.js';
8
- import { computePrivateFunctionLeaf, computePrivateFunctionsTree } from './private_function.js';
9
- /**
10
- * Creates a membership proof for a private function in a contract class, to be verified via `isValidPrivateFunctionMembershipProof`.
11
- * @param selector - Selector of the function to create the proof for.
12
- * @param artifact - Artifact of the contract class where the function is defined.
13
- */ export async function createPrivateFunctionMembershipProof(selector, artifact) {
14
- const log = createLogger('circuits:function_membership_proof');
15
- // Locate private function definition and artifact
16
- const privateFunctions = artifact.functions.filter((fn)=>fn.functionType === FunctionType.PRIVATE);
17
- const privateFunctionsFromArtifact = await Promise.all(privateFunctions.map(getContractClassPrivateFunctionFromArtifact));
18
- const privateFunction = privateFunctionsFromArtifact.find((fn)=>fn.selector.equals(selector));
19
- const privateFunctionsAndSelectors = await Promise.all(privateFunctions.map(async (fn)=>({
20
- fn,
21
- selector: await FunctionSelector.fromNameAndParameters(fn.name, fn.parameters)
22
- })));
23
- const privateFunctionArtifact = privateFunctionsAndSelectors.find((fnAndSelector)=>selector.equals(fnAndSelector.selector))?.fn;
24
- if (!privateFunction || !privateFunctionArtifact) {
25
- throw new Error(`Private function with selector ${selector.toString()} not found`);
26
- }
27
- // Compute preimage for the artifact hash
28
- const { utilityFunctionRoot: utilityFunctionsTreeRoot, metadataHash: artifactMetadataHash } = await computeArtifactHashPreimage(artifact);
29
- // We need two sibling paths because private function information is split across two trees:
30
- // The "private function tree" captures the selectors and verification keys, and is used in the kernel circuit for verifying the proof generated by the app circuit.
31
- const functionLeaf = await computePrivateFunctionLeaf(privateFunction);
32
- const functionsTree = await computePrivateFunctionsTree(privateFunctionsFromArtifact);
33
- const functionsTreeLeafIndex = functionsTree.getIndex(functionLeaf);
34
- const functionsTreeSiblingPath = functionsTree.getSiblingPath(functionsTreeLeafIndex).map(Fr.fromBuffer);
35
- // And the "artifact tree" captures function bytecode and metadata, and is used by the pxe to check that its executing the code it's supposed to be executing, but it never goes into circuits.
36
- const functionMetadataHash = computeFunctionMetadataHash(privateFunctionArtifact);
37
- const functionArtifactHash = await computeFunctionArtifactHash({
38
- ...privateFunctionArtifact,
39
- functionMetadataHash
40
- });
41
- const artifactTree = await computeArtifactFunctionTree(artifact, FunctionType.PRIVATE);
42
- const artifactTreeLeafIndex = artifactTree.getIndex(functionArtifactHash.toBuffer());
43
- const artifactTreeSiblingPath = artifactTree.getSiblingPath(artifactTreeLeafIndex).map(Fr.fromBuffer);
44
- log.debug(`Computed proof for private function with selector ${selector.toString()}`, {
45
- functionArtifactHash,
46
- functionMetadataHash,
47
- functionLeaf: '0x' + functionLeaf.toString('hex'),
48
- artifactMetadataHash,
49
- privateFunctionsTreeRoot: '0x' + functionsTree.root.toString('hex'),
50
- utilityFunctionsTreeRoot,
51
- artifactFunctionTreeSiblingPath: artifactTreeSiblingPath.map((fr)=>fr.toString()).join(','),
52
- privateFunctionTreeSiblingPath: functionsTreeSiblingPath.map((fr)=>fr.toString()).join(',')
53
- });
54
- return {
55
- artifactTreeSiblingPath,
56
- artifactTreeLeafIndex,
57
- artifactMetadataHash,
58
- functionMetadataHash,
59
- utilityFunctionsTreeRoot,
60
- privateFunctionTreeSiblingPath: functionsTreeSiblingPath,
61
- privateFunctionTreeLeafIndex: functionsTreeLeafIndex
62
- };
63
- }
64
- /**
65
- * Verifies that a private function with a membership proof as emitted by the ClassRegistry contract is valid,
66
- * as defined in the protocol specs at contract-deployment/classes:
67
- *
68
- * ```
69
- * // Load contract class from local db
70
- * contract_class = db.get_contract_class(contract_class_id)
71
- *
72
- * // Compute function leaf and assert it belongs to the private functions tree
73
- * function_leaf = pedersen([selector as Field, vk_hash], GENERATOR__PRIVATE_FUNCTION_LEAF)
74
- * computed_private_function_tree_root = compute_root(function_leaf, private_function_tree_sibling_path)
75
- * assert computed_private_function_tree_root == contract_class.private_functions_root
76
- *
77
- * // Compute artifact leaf and assert it belongs to the artifact
78
- * artifact_function_leaf = sha256(selector, metadata_hash, sha256(bytecode))
79
- * computed_artifact_private_function_tree_root = compute_root(artifact_function_leaf, artifact_function_tree_sibling_path)
80
- * computed_artifact_hash = sha256(computed_artifact_private_function_tree_root, utility_functions_artifact_tree_root, artifact_metadata_hash)
81
- * assert computed_artifact_hash == contract_class.artifact_hash
82
- * ```
83
- * @param fn - Function to check membership proof for.
84
- * @param contractClass - In which contract class the function is expected to be.
85
- */ export async function isValidPrivateFunctionMembershipProof(fn, contractClass) {
86
- const log = createLogger('circuits:function_membership_proof');
87
- // Check private function tree membership
88
- const functionLeaf = await computePrivateFunctionLeaf(fn);
89
- const rootBuffer = await computeRootFromSiblingPath(functionLeaf, fn.privateFunctionTreeSiblingPath.map((fr)=>fr.toBuffer()), fn.privateFunctionTreeLeafIndex, async (left, right)=>(await poseidon2Hash([
90
- left,
91
- right
92
- ])).toBuffer());
93
- const computedPrivateFunctionTreeRoot = Fr.fromBuffer(rootBuffer);
94
- if (!contractClass.privateFunctionsRoot.equals(computedPrivateFunctionTreeRoot)) {
95
- log.debug(`Private function tree root mismatch`, {
96
- expectedPrivateFunctionTreeRoot: contractClass.privateFunctionsRoot,
97
- computedPrivateFunctionTreeRoot: computedPrivateFunctionTreeRoot,
98
- computedFunctionLeaf: '0x' + functionLeaf.toString('hex')
99
- });
100
- return false;
101
- }
102
- // Check artifact hash
103
- const functionArtifactHash = await computeFunctionArtifactHash(fn);
104
- const computedArtifactPrivateFunctionTreeRootBuffer = await computeRootFromSiblingPath(functionArtifactHash.toBuffer(), fn.artifactTreeSiblingPath.map((fr)=>fr.toBuffer()), fn.artifactTreeLeafIndex, getArtifactMerkleTreeHasher());
105
- const computedArtifactPrivateFunctionTreeRoot = Fr.fromBuffer(computedArtifactPrivateFunctionTreeRootBuffer);
106
- const computedArtifactHash = await computeArtifactHash({
107
- privateFunctionRoot: computedArtifactPrivateFunctionTreeRoot,
108
- utilityFunctionRoot: fn.utilityFunctionsTreeRoot,
109
- metadataHash: fn.artifactMetadataHash
110
- });
111
- if (!contractClass.artifactHash.equals(computedArtifactHash)) {
112
- log.debug(`Artifact hash mismatch`, {
113
- expected: contractClass.artifactHash,
114
- computedArtifactHash,
115
- computedFunctionArtifactHash: functionArtifactHash,
116
- computedArtifactPrivateFunctionTreeRoot,
117
- utilityFunctionRoot: fn.utilityFunctionsTreeRoot,
118
- metadataHash: fn.artifactMetadataHash,
119
- artifactFunctionTreeSiblingPath: fn.artifactTreeSiblingPath.map((fr)=>fr.toString()).join(',')
120
- });
121
- return false;
122
- }
123
- return true;
124
- }
@@ -1,27 +0,0 @@
1
- import { type ContractArtifact, FunctionSelector } from '../abi/index.js';
2
- import type { ContractClassPublic, UtilityFunctionMembershipProof, UtilityFunctionWithMembershipProof } from './interfaces/index.js';
3
- /**
4
- * Creates a membership proof for a utility function in a contract class, to be verified via `isValidUtilityFunctionMembershipProof`.
5
- * @param selector - Selector of the function to create the proof for.
6
- * @param artifact - Artifact of the contract class where the function is defined.
7
- */
8
- export declare function createUtilityFunctionMembershipProof(selector: FunctionSelector, artifact: ContractArtifact): Promise<UtilityFunctionMembershipProof>;
9
- /**
10
- * Verifies that a utility function with a membership proof as emitted by the ClassRegistry contract is valid,
11
- * as defined in the protocol specs at contract-deployment/classes:
12
- *
13
- * ```
14
- * // Load contract class from local db
15
- * contract_class = db.get_contract_class(contract_class_id)
16
- *
17
- * // Compute artifact leaf and assert it belongs to the artifact
18
- * artifact_function_leaf = sha256(selector, metadata_hash, sha256(bytecode))
19
- * computed_artifact_utility_function_tree_root = compute_root(artifact_function_leaf, artifact_function_tree_sibling_path, artifact_function_tree_leaf_index)
20
- * computed_artifact_hash = sha256(private_functions_artifact_tree_root, computed_artifact_utility_function_tree_root, artifact_metadata_hash)
21
- * assert computed_artifact_hash == contract_class.artifact_hash
22
- * ```
23
- * @param fn - Function to check membership proof for.
24
- * @param contractClass - In which contract class the function is expected to be.
25
- */
26
- export declare function isValidUtilityFunctionMembershipProof(fn: UtilityFunctionWithMembershipProof, contractClass: Pick<ContractClassPublic, 'artifactHash'>): Promise<boolean>;
27
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbGl0eV9mdW5jdGlvbl9tZW1iZXJzaGlwX3Byb29mLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29udHJhY3QvdXRpbGl0eV9mdW5jdGlvbl9tZW1iZXJzaGlwX3Byb29mLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUlBLE9BQU8sRUFBRSxLQUFLLGdCQUFnQixFQUFFLGdCQUFnQixFQUFnQixNQUFNLGlCQUFpQixDQUFDO0FBU3hGLE9BQU8sS0FBSyxFQUNWLG1CQUFtQixFQUNuQiw4QkFBOEIsRUFDOUIsa0NBQWtDLEVBQ25DLE1BQU0sdUJBQXVCLENBQUM7QUFFL0I7Ozs7R0FJRztBQUNILHdCQUFzQixvQ0FBb0MsQ0FDeEQsUUFBUSxFQUFFLGdCQUFnQixFQUMxQixRQUFRLEVBQUUsZ0JBQWdCLEdBQ3pCLE9BQU8sQ0FBQyw4QkFBOEIsQ0FBQyxDQXNDekM7QUFFRDs7Ozs7Ozs7Ozs7Ozs7OztHQWdCRztBQUNILHdCQUFzQixxQ0FBcUMsQ0FDekQsRUFBRSxFQUFFLGtDQUFrQyxFQUN0QyxhQUFhLEVBQUUsSUFBSSxDQUFDLG1CQUFtQixFQUFFLGNBQWMsQ0FBQyxvQkErQnpEIn0=
@@ -1 +0,0 @@
1
- {"version":3,"file":"utility_function_membership_proof.d.ts","sourceRoot":"","sources":["../../src/contract/utility_function_membership_proof.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,gBAAgB,EAAE,gBAAgB,EAAgB,MAAM,iBAAiB,CAAC;AASxF,OAAO,KAAK,EACV,mBAAmB,EACnB,8BAA8B,EAC9B,kCAAkC,EACnC,MAAM,uBAAuB,CAAC;AAE/B;;;;GAIG;AACH,wBAAsB,oCAAoC,CACxD,QAAQ,EAAE,gBAAgB,EAC1B,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,8BAA8B,CAAC,CAsCzC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,qCAAqC,CACzD,EAAE,EAAE,kCAAkC,EACtC,aAAa,EAAE,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC,oBA+BzD"}
@@ -1,87 +0,0 @@
1
- import { Fr } from '@aztec/foundation/curves/bn254';
2
- import { createLogger } from '@aztec/foundation/log';
3
- import { computeRootFromSiblingPath } from '@aztec/foundation/trees';
4
- import { FunctionSelector, FunctionType } from '../abi/index.js';
5
- import { computeArtifactFunctionTree, computeArtifactHash, computeArtifactHashPreimage, computeFunctionArtifactHash, computeFunctionMetadataHash, getArtifactMerkleTreeHasher } from './artifact_hash.js';
6
- /**
7
- * Creates a membership proof for a utility function in a contract class, to be verified via `isValidUtilityFunctionMembershipProof`.
8
- * @param selector - Selector of the function to create the proof for.
9
- * @param artifact - Artifact of the contract class where the function is defined.
10
- */ export async function createUtilityFunctionMembershipProof(selector, artifact) {
11
- const log = createLogger('circuits:function_membership_proof');
12
- // Locate function artifact
13
- const utilityFunctions = artifact.functions.filter((fn)=>fn.functionType === FunctionType.UTILITY);
14
- const utilityFunctionsAndSelectors = await Promise.all(utilityFunctions.map(async (fn)=>({
15
- fn,
16
- selector: await FunctionSelector.fromNameAndParameters(fn)
17
- })));
18
- const fn = utilityFunctionsAndSelectors.find((fnAndSelector)=>selector.equals(fnAndSelector.selector))?.fn;
19
- if (!fn) {
20
- throw new Error(`Utility function with selector ${selector.toString()} not found`);
21
- }
22
- // Compute preimage for the artifact hash
23
- const { privateFunctionRoot: privateFunctionsArtifactTreeRoot, metadataHash: artifactMetadataHash } = await computeArtifactHashPreimage(artifact);
24
- // Compute the sibling path for the "artifact tree"
25
- const functionMetadataHash = computeFunctionMetadataHash(fn);
26
- const functionArtifactHash = await computeFunctionArtifactHash({
27
- ...fn,
28
- functionMetadataHash
29
- });
30
- const artifactTree = await computeArtifactFunctionTree(artifact, FunctionType.UTILITY);
31
- const artifactTreeLeafIndex = artifactTree.getIndex(functionArtifactHash.toBuffer());
32
- const artifactTreeSiblingPath = artifactTree.getSiblingPath(artifactTreeLeafIndex).map(Fr.fromBuffer);
33
- log.debug(`Computed proof for utility function with selector ${selector.toString()}`, {
34
- functionArtifactHash,
35
- functionMetadataHash,
36
- artifactMetadataHash,
37
- artifactFunctionTreeSiblingPath: artifactTreeSiblingPath.map((fr)=>fr.toString()).join(','),
38
- privateFunctionsArtifactTreeRoot
39
- });
40
- return {
41
- artifactTreeSiblingPath,
42
- artifactTreeLeafIndex,
43
- artifactMetadataHash,
44
- functionMetadataHash,
45
- privateFunctionsArtifactTreeRoot
46
- };
47
- }
48
- /**
49
- * Verifies that a utility function with a membership proof as emitted by the ClassRegistry contract is valid,
50
- * as defined in the protocol specs at contract-deployment/classes:
51
- *
52
- * ```
53
- * // Load contract class from local db
54
- * contract_class = db.get_contract_class(contract_class_id)
55
- *
56
- * // Compute artifact leaf and assert it belongs to the artifact
57
- * artifact_function_leaf = sha256(selector, metadata_hash, sha256(bytecode))
58
- * computed_artifact_utility_function_tree_root = compute_root(artifact_function_leaf, artifact_function_tree_sibling_path, artifact_function_tree_leaf_index)
59
- * computed_artifact_hash = sha256(private_functions_artifact_tree_root, computed_artifact_utility_function_tree_root, artifact_metadata_hash)
60
- * assert computed_artifact_hash == contract_class.artifact_hash
61
- * ```
62
- * @param fn - Function to check membership proof for.
63
- * @param contractClass - In which contract class the function is expected to be.
64
- */ export async function isValidUtilityFunctionMembershipProof(fn, contractClass) {
65
- const log = createLogger('circuits:function_membership_proof');
66
- const functionArtifactHash = await computeFunctionArtifactHash(fn);
67
- const computedArtifactFunctionTreeRootBuffer = await computeRootFromSiblingPath(functionArtifactHash.toBuffer(), fn.artifactTreeSiblingPath.map((fr)=>fr.toBuffer()), fn.artifactTreeLeafIndex, getArtifactMerkleTreeHasher());
68
- const computedArtifactFunctionTreeRoot = Fr.fromBuffer(computedArtifactFunctionTreeRootBuffer);
69
- const computedArtifactHash = await computeArtifactHash({
70
- privateFunctionRoot: fn.privateFunctionsArtifactTreeRoot,
71
- utilityFunctionRoot: computedArtifactFunctionTreeRoot,
72
- metadataHash: fn.artifactMetadataHash
73
- });
74
- if (!contractClass.artifactHash.equals(computedArtifactHash)) {
75
- log.debug(`Artifact hash mismatch`, {
76
- expected: contractClass.artifactHash,
77
- computedArtifactHash,
78
- computedFunctionArtifactHash: functionArtifactHash,
79
- computedArtifactFunctionTreeRoot,
80
- privateFunctionsArtifactTreeRoot: fn.privateFunctionsArtifactTreeRoot,
81
- metadataHash: fn.artifactMetadataHash,
82
- artifactFunctionTreeSiblingPath: fn.artifactTreeSiblingPath.map((fr)=>fr.toString()).join(',')
83
- });
84
- return false;
85
- }
86
- return true;
87
- }