@aztec/protocol-contracts 0.0.1-commit.e3c1de76 → 0.0.1-commit.e57c76e

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 (91) hide show
  1. package/artifacts/ContractClassRegistry.json +2376 -4410
  2. package/artifacts/ContractInstanceRegistry.json +3124 -945
  3. package/artifacts/FeeJuice.json +3541 -918
  4. package/dest/class-registry/contract_class_published_event.d.ts +6 -3
  5. package/dest/class-registry/contract_class_published_event.d.ts.map +1 -1
  6. package/dest/class-registry/contract_class_published_event.js +10 -16
  7. package/dest/class-registry/index.d.ts +1 -3
  8. package/dest/class-registry/index.d.ts.map +1 -1
  9. package/dest/class-registry/index.js +3 -5
  10. package/dest/class-registry/lazy.d.ts +1 -3
  11. package/dest/class-registry/lazy.d.ts.map +1 -1
  12. package/dest/class-registry/lazy.js +1 -3
  13. package/dest/fee-juice/index.d.ts +1 -1
  14. package/dest/fee-juice/index.d.ts.map +1 -1
  15. package/dest/fee-juice/index.js +3 -3
  16. package/dest/fee-juice/lazy.js +1 -1
  17. package/dest/instance-registry/contract_instance_published_event.d.ts +3 -2
  18. package/dest/instance-registry/contract_instance_published_event.d.ts.map +1 -1
  19. package/dest/instance-registry/contract_instance_published_event.js +7 -3
  20. package/dest/instance-registry/index.d.ts +1 -1
  21. package/dest/instance-registry/index.d.ts.map +1 -1
  22. package/dest/instance-registry/index.js +3 -3
  23. package/dest/instance-registry/lazy.js +1 -1
  24. package/dest/make_protocol_contract.d.ts +4 -4
  25. package/dest/make_protocol_contract.d.ts.map +1 -1
  26. package/dest/make_protocol_contract.js +30 -14
  27. package/dest/protocol_contract_data.d.ts +14 -5
  28. package/dest/protocol_contract_data.d.ts.map +1 -1
  29. package/dest/protocol_contract_data.js +67 -27
  30. package/dest/provider/bundle.d.ts +1 -1
  31. package/dest/provider/bundle.d.ts.map +1 -1
  32. package/dest/provider/bundle.js +2 -8
  33. package/dest/provider/lazy.d.ts +1 -1
  34. package/dest/provider/lazy.d.ts.map +1 -1
  35. package/dest/provider/lazy.js +0 -9
  36. package/dest/scripts/generate_data.js +73 -26
  37. package/dest/tests/fixtures.d.ts +1 -3
  38. package/dest/tests/fixtures.d.ts.map +1 -1
  39. package/dest/tests/fixtures.js +0 -10
  40. package/package.json +4 -4
  41. package/src/class-registry/contract_class_published_event.ts +10 -21
  42. package/src/class-registry/index.ts +3 -5
  43. package/src/class-registry/lazy.ts +1 -3
  44. package/src/fee-juice/index.ts +3 -3
  45. package/src/fee-juice/lazy.ts +1 -1
  46. package/src/instance-registry/contract_instance_published_event.ts +5 -1
  47. package/src/instance-registry/index.ts +3 -3
  48. package/src/instance-registry/lazy.ts +1 -1
  49. package/src/make_protocol_contract.ts +39 -15
  50. package/src/protocol_contract_data.ts +57 -30
  51. package/src/provider/bundle.ts +1 -7
  52. package/src/provider/lazy.ts +0 -9
  53. package/src/tests/fixtures.ts +0 -12
  54. package/artifacts/AuthRegistry.d.json.ts +0 -5
  55. package/artifacts/AuthRegistry.json +0 -2764
  56. package/artifacts/MultiCallEntrypoint.d.json.ts +0 -5
  57. package/artifacts/MultiCallEntrypoint.json +0 -2759
  58. package/artifacts/PublicChecks.d.json.ts +0 -5
  59. package/artifacts/PublicChecks.json +0 -970
  60. package/dest/auth-registry/index.d.ts +0 -6
  61. package/dest/auth-registry/index.d.ts.map +0 -1
  62. package/dest/auth-registry/index.js +0 -13
  63. package/dest/auth-registry/lazy.d.ts +0 -6
  64. package/dest/auth-registry/lazy.d.ts.map +0 -1
  65. package/dest/auth-registry/lazy.js +0 -23
  66. package/dest/class-registry/private_function_broadcasted_event.d.ts +0 -44
  67. package/dest/class-registry/private_function_broadcasted_event.d.ts.map +0 -1
  68. package/dest/class-registry/private_function_broadcasted_event.js +0 -85
  69. package/dest/class-registry/utility_function_broadcasted_event.d.ts +0 -38
  70. package/dest/class-registry/utility_function_broadcasted_event.d.ts.map +0 -1
  71. package/dest/class-registry/utility_function_broadcasted_event.js +0 -81
  72. package/dest/multi-call-entrypoint/index.d.ts +0 -5
  73. package/dest/multi-call-entrypoint/index.d.ts.map +0 -1
  74. package/dest/multi-call-entrypoint/index.js +0 -13
  75. package/dest/multi-call-entrypoint/lazy.d.ts +0 -6
  76. package/dest/multi-call-entrypoint/lazy.d.ts.map +0 -1
  77. package/dest/multi-call-entrypoint/lazy.js +0 -23
  78. package/dest/public-checks/index.d.ts +0 -5
  79. package/dest/public-checks/index.d.ts.map +0 -1
  80. package/dest/public-checks/index.js +0 -13
  81. package/dest/public-checks/lazy.d.ts +0 -6
  82. package/dest/public-checks/lazy.d.ts.map +0 -1
  83. package/dest/public-checks/lazy.js +0 -23
  84. package/src/auth-registry/index.ts +0 -18
  85. package/src/auth-registry/lazy.ts +0 -29
  86. package/src/class-registry/private_function_broadcasted_event.ts +0 -109
  87. package/src/class-registry/utility_function_broadcasted_event.ts +0 -103
  88. package/src/multi-call-entrypoint/index.ts +0 -18
  89. package/src/multi-call-entrypoint/lazy.ts +0 -29
  90. package/src/public-checks/index.ts +0 -18
  91. package/src/public-checks/lazy.ts +0 -29
@@ -1,24 +1,15 @@
1
- import { getCanonicalAuthRegistry } from '../auth-registry/lazy.js';
2
1
  import { getCanonicalClassRegistry } from '../class-registry/lazy.js';
3
2
  import { getCanonicalFeeJuice } from '../fee-juice/lazy.js';
4
3
  import { getCanonicalInstanceRegistry } from '../instance-registry/lazy.js';
5
- import { getCanonicalMultiCallEntrypoint } from '../multi-call-entrypoint/lazy.js';
6
- import { getCanonicalPublicChecks } from '../public-checks/lazy.js';
7
4
  export class LazyProtocolContractsProvider {
8
5
  getProtocolContractArtifact(name) {
9
6
  switch(name){
10
- case 'AuthRegistry':
11
- return getCanonicalAuthRegistry();
12
7
  case 'ContractInstanceRegistry':
13
8
  return getCanonicalInstanceRegistry();
14
9
  case 'ContractClassRegistry':
15
10
  return getCanonicalClassRegistry();
16
- case 'MultiCallEntrypoint':
17
- return getCanonicalMultiCallEntrypoint();
18
11
  case 'FeeJuice':
19
12
  return getCanonicalFeeJuice();
20
- case 'PublicChecks':
21
- return getCanonicalPublicChecks();
22
13
  default:
23
14
  throw new Error(`Unknown protocol contract name: ${name}`);
24
15
  }
@@ -1,11 +1,16 @@
1
- import { CANONICAL_AUTH_REGISTRY_ADDRESS, CONTRACT_CLASS_REGISTRY_CONTRACT_ADDRESS, CONTRACT_INSTANCE_PUBLISHED_MAGIC_VALUE, CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS, FEE_JUICE_ADDRESS, GeneratorIndex, MAX_PROTOCOL_CONTRACTS, MULTI_CALL_ENTRYPOINT_ADDRESS, PUBLIC_CHECKS_ADDRESS } from '@aztec/constants';
1
+ // Reads compiled Noir artifacts for each protocol contract and derives their addresses, class IDs,
2
+ // bytecode commitments, and other deployment data, emitting everything as precomputed constants into
3
+ // `protocol_contract_data.ts`. This avoids clients repeating the expensive hashing at runtime and
4
+ // ensures a single source of truth for the protocol contracts hash enforced by circuits, P2P, and L1.
5
+ import { CONTRACT_CLASS_REGISTRY_CONTRACT_ADDRESS, CONTRACT_INSTANCE_PUBLISHED_MAGIC_VALUE, CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS, FEE_JUICE_ADDRESS, MAX_PROTOCOL_CONTRACTS } from '@aztec/constants';
2
6
  import { makeTuple } from '@aztec/foundation/array';
3
- import { poseidon2HashWithSeparator } from '@aztec/foundation/crypto/poseidon';
4
7
  import { Fr } from '@aztec/foundation/curves/bn254';
5
8
  import { createConsoleLogger } from '@aztec/foundation/log';
6
9
  import { loadContractArtifact } from '@aztec/stdlib/abi';
7
10
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
8
- import { getContractInstanceFromInstantiationParams } from '@aztec/stdlib/contract';
11
+ import { computeContractAddressFromInstance, computeInitializationHash, getContractClassFromArtifact } from '@aztec/stdlib/contract';
12
+ import { computeSiloedPrivateLogFirstField } from '@aztec/stdlib/hash';
13
+ import { PublicKeys } from '@aztec/stdlib/keys';
9
14
  import { ProtocolContracts } from '@aztec/stdlib/tx';
10
15
  import { promises as fs } from 'fs';
11
16
  import path from 'path';
@@ -16,12 +21,9 @@ const destArtifactsDir = './artifacts';
16
21
  const outputFilePath = './src/protocol_contract_data.ts';
17
22
  const salt = new Fr(1);
18
23
  const contractAddressMapping = {
19
- AuthRegistry: CANONICAL_AUTH_REGISTRY_ADDRESS,
20
24
  ContractInstanceRegistry: CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS,
21
25
  ContractClassRegistry: CONTRACT_CLASS_REGISTRY_CONTRACT_ADDRESS,
22
- MultiCallEntrypoint: MULTI_CALL_ENTRYPOINT_ADDRESS,
23
- FeeJuice: FEE_JUICE_ADDRESS,
24
- PublicChecks: PUBLIC_CHECKS_ADDRESS
26
+ FeeJuice: FEE_JUICE_ADDRESS
25
27
  };
26
28
  async function clearDestDir() {
27
29
  try {
@@ -50,11 +52,33 @@ async function copyArtifact(srcName, destName) {
50
52
  await fs.copyFile(src, dest);
51
53
  return artifact;
52
54
  }
53
- async function computeAddress(artifact) {
54
- const instance = await getContractInstanceFromInstantiationParams(loadContractArtifact(artifact), {
55
- salt
56
- });
57
- return instance.address;
55
+ // Precompute all the expensive contract data that can be obtained from the artifact, to avoid redundant computations in clients.
56
+ // Protocol contracts come from a trusted source, so no class verifications are needed.
57
+ async function computeContractData(artifact, deployer) {
58
+ const loaded = loadContractArtifact(artifact);
59
+ const contractClass = await getContractClassFromArtifact(loaded);
60
+ const constructorArtifact = loaded.functions.find((f)=>f.name === 'constructor');
61
+ const initializationHash = await computeInitializationHash(constructorArtifact, []);
62
+ const instance = {
63
+ version: 2,
64
+ currentContractClassId: contractClass.id,
65
+ originalContractClassId: contractClass.id,
66
+ initializationHash,
67
+ immutablesHash: Fr.ZERO,
68
+ publicKeys: PublicKeys.default(),
69
+ salt,
70
+ deployer
71
+ };
72
+ const address = await computeContractAddressFromInstance(instance);
73
+ return {
74
+ address,
75
+ classId: contractClass.id,
76
+ artifactHash: contractClass.artifactHash,
77
+ privateFunctionsRoot: contractClass.privateFunctionsRoot,
78
+ publicBytecodeCommitment: contractClass.publicBytecodeCommitment,
79
+ initializationHash,
80
+ privateFunctions: contractClass.privateFunctions
81
+ };
58
82
  }
59
83
  async function generateDeclarationFile(destName) {
60
84
  const content = `
@@ -88,14 +112,37 @@ function generateContractAddresses(names) {
88
112
  };
89
113
  `;
90
114
  }
91
- function generateDerivedAddresses(names, derivedAddresses) {
115
+ function generateDerivedAddresses(names, contractData) {
92
116
  return `
93
117
  export const ProtocolContractDerivedAddress = {
94
- ${derivedAddresses.map((address, i)=>`${names[i]}: AztecAddress.fromString('${address.toString()}')`).join(',\n')}
118
+ ${contractData.map((d, i)=>`${names[i]}: AztecAddress.fromString('${d.address.toString()}')`).join(',\n')}
119
+ };
120
+ `;
121
+ }
122
+ function generateClassIdPreimages(names, contractData) {
123
+ return `
124
+ export const ProtocolContractClassId: Record<ProtocolContractName, Fr> = {
125
+ ${contractData.map((d, i)=>`${names[i]}: Fr.fromString('${d.classId.toString()}')`).join(',\n')}
126
+ };
127
+
128
+ export const ProtocolContractClassIdPreimage: Record<ProtocolContractName, { artifactHash: Fr; privateFunctionsRoot: Fr; publicBytecodeCommitment: Fr }> = {
129
+ ${contractData.map((d, i)=>`${names[i]}: {
130
+ artifactHash: Fr.fromString('${d.artifactHash.toString()}'),
131
+ privateFunctionsRoot: Fr.fromString('${d.privateFunctionsRoot.toString()}'),
132
+ publicBytecodeCommitment: Fr.fromString('${d.publicBytecodeCommitment.toString()}'),
133
+ }`).join(',\n')}
134
+ };
135
+
136
+ export const ProtocolContractInitializationHash: Record<ProtocolContractName, Fr> = {
137
+ ${contractData.map((d, i)=>`${names[i]}: Fr.fromString('${d.initializationHash.toString()}')`).join(',\n')}
138
+ };
139
+
140
+ export const ProtocolContractPrivateFunctions: Record<ProtocolContractName, { selector: FunctionSelector; vkHash: Fr }[]> = {
141
+ ${contractData.map((d, i)=>`${names[i]}: [${d.privateFunctions.map((fn)=>`{ selector: FunctionSelector.fromField(Fr.fromString('${fn.selector.toField().toString()}')), vkHash: Fr.fromString('${fn.vkHash.toString()}') }`).join(', ')}]`).join(',\n')}
95
142
  };
96
143
  `;
97
144
  }
98
- async function generateProtocolContractsList(names, derivedAddresses) {
145
+ async function generateProtocolContractsList(names, contractData) {
99
146
  const list = makeTuple(MAX_PROTOCOL_CONTRACTS, ()=>AztecAddress.zero());
100
147
  for(let i = 0; i < names.length; i++){
101
148
  const name = names[i];
@@ -104,7 +151,7 @@ async function generateProtocolContractsList(names, derivedAddresses) {
104
151
  if (!list[derivedAddressIndex].equals(AztecAddress.zero())) {
105
152
  throw new Error(`Duplicate protocol contract address: ${address.toString()}`);
106
153
  }
107
- list[derivedAddressIndex] = derivedAddresses[i];
154
+ list[derivedAddressIndex] = contractData[i].address;
108
155
  }
109
156
  return `
110
157
  export const ProtocolContractsList = new ProtocolContracts([
@@ -117,16 +164,14 @@ async function generateProtocolContractsList(names, derivedAddresses) {
117
164
  // Generate the siloed log tags for events emitted via private logs.
118
165
  async function generateLogTags() {
119
166
  return `
120
- export const CONTRACT_INSTANCE_PUBLISHED_EVENT_TAG = Fr.fromHexString('${await poseidon2HashWithSeparator([
121
- CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS,
122
- CONTRACT_INSTANCE_PUBLISHED_MAGIC_VALUE
123
- ], GeneratorIndex.PRIVATE_LOG_FIRST_FIELD)}');
167
+ export const CONTRACT_INSTANCE_PUBLISHED_EVENT_TAG = Fr.fromHexString('${await computeSiloedPrivateLogFirstField(new AztecAddress(new Fr(CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS)), new Fr(CONTRACT_INSTANCE_PUBLISHED_MAGIC_VALUE))}');
124
168
  `;
125
169
  }
126
- async function generateOutputFile(names, derivedAddresses) {
170
+ async function generateOutputFile(names, contractData) {
127
171
  const content = `
128
172
  // GENERATED FILE - DO NOT EDIT. RUN \`yarn generate\` or \`yarn generate:data\`
129
173
  import { Fr } from '@aztec/foundation/curves/bn254';
174
+ import { FunctionSelector } from '@aztec/stdlib/abi';
130
175
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
131
176
  import { ProtocolContracts } from '@aztec/stdlib/tx';
132
177
 
@@ -136,9 +181,11 @@ async function generateOutputFile(names, derivedAddresses) {
136
181
 
137
182
  ${generateContractAddresses(names)}
138
183
 
139
- ${generateDerivedAddresses(names, derivedAddresses)}
184
+ ${generateDerivedAddresses(names, contractData)}
185
+
186
+ ${generateClassIdPreimages(names, contractData)}
140
187
 
141
- ${await generateProtocolContractsList(names, derivedAddresses)}
188
+ ${await generateProtocolContractsList(names, contractData)}
142
189
 
143
190
  ${await generateLogTags()}
144
191
  `;
@@ -147,16 +194,16 @@ async function generateOutputFile(names, derivedAddresses) {
147
194
  async function main() {
148
195
  await clearDestDir();
149
196
  const srcNames = JSON.parse(await fs.readFile(path.join(noirContractsRoot, 'protocol_contracts.json'), 'utf8'));
150
- const derivedAddresses = [];
197
+ const contractDataList = [];
151
198
  const destNames = srcNames.map((n)=>n.split('-')[1]);
152
199
  for(let i = 0; i < srcNames.length; i++){
153
200
  const srcName = srcNames[i];
154
201
  const destName = destNames[i];
155
202
  const artifact = await copyArtifact(srcName, destName);
156
203
  await generateDeclarationFile(destName);
157
- derivedAddresses.push(await computeAddress(artifact));
204
+ contractDataList.push(await computeContractData(artifact, AztecAddress.fromBigInt(BigInt(contractAddressMapping[destName]))));
158
205
  }
159
- await generateOutputFile(destNames, derivedAddresses);
206
+ await generateOutputFile(destNames, contractDataList);
160
207
  }
161
208
  try {
162
209
  await main();
@@ -1,6 +1,4 @@
1
1
  export declare function getSampleContractClassPublishedEventPayload(): Buffer;
2
- export declare function getSamplePrivateFunctionBroadcastedEventPayload(): Buffer;
3
- export declare function getSampleUtilityFunctionBroadcastedEventPayload(): Buffer;
4
2
  export declare function getSampleContractInstancePublishedEventPayload(): Buffer;
5
3
  export declare function getPathToFixture(name: string): string;
6
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZml4dHVyZXMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy90ZXN0cy9maXh0dXJlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFLQSx3QkFBZ0IsMkNBQTJDLElBQUksTUFBTSxDQUdwRTtBQUdELHdCQUFnQiwrQ0FBK0MsSUFBSSxNQUFNLENBR3hFO0FBR0Qsd0JBQWdCLCtDQUErQyxJQUFJLE1BQU0sQ0FHeEU7QUFHRCx3QkFBZ0IsOENBQThDLElBQUksTUFBTSxDQUd2RTtBQUVELHdCQUFnQixnQkFBZ0IsQ0FBQyxJQUFJLEVBQUUsTUFBTSxVQUU1QyJ9
4
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZml4dHVyZXMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy90ZXN0cy9maXh0dXJlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFLQSx3QkFBZ0IsMkNBQTJDLElBQUksTUFBTSxDQUdwRTtBQUdELHdCQUFnQiw4Q0FBOEMsSUFBSSxNQUFNLENBR3ZFO0FBRUQsd0JBQWdCLGdCQUFnQixDQUFDLElBQUksRUFBRSxNQUFNLFVBRTVDIn0=
@@ -1 +1 @@
1
- {"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../../src/tests/fixtures.ts"],"names":[],"mappings":"AAKA,wBAAgB,2CAA2C,IAAI,MAAM,CAGpE;AAGD,wBAAgB,+CAA+C,IAAI,MAAM,CAGxE;AAGD,wBAAgB,+CAA+C,IAAI,MAAM,CAGxE;AAGD,wBAAgB,8CAA8C,IAAI,MAAM,CAGvE;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,UAE5C"}
1
+ {"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../../src/tests/fixtures.ts"],"names":[],"mappings":"AAKA,wBAAgB,2CAA2C,IAAI,MAAM,CAGpE;AAGD,wBAAgB,8CAA8C,IAAI,MAAM,CAGvE;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,UAE5C"}
@@ -7,16 +7,6 @@ export function getSampleContractClassPublishedEventPayload() {
7
7
  return Buffer.from(readFileSync(path).toString(), 'hex');
8
8
  }
9
9
  // Generated from end-to-end/src/e2e_deploy_contract/contract_class_registration.test.ts with AZTEC_GENERATE_TEST_DATA=1
10
- export function getSamplePrivateFunctionBroadcastedEventPayload() {
11
- const path = getPathToFixture('PrivateFunctionBroadcastedEventData.hex');
12
- return Buffer.from(readFileSync(path).toString(), 'hex');
13
- }
14
- // Generated from end-to-end/src/e2e_deploy_contract/contract_class_registration.test.ts with AZTEC_GENERATE_TEST_DATA=1
15
- export function getSampleUtilityFunctionBroadcastedEventPayload() {
16
- const path = getPathToFixture('UtilityFunctionBroadcastedEventData.hex');
17
- return Buffer.from(readFileSync(path).toString(), 'hex');
18
- }
19
- // Generated from end-to-end/src/e2e_deploy_contract/contract_class_registration.test.ts with AZTEC_GENERATE_TEST_DATA=1
20
10
  export function getSampleContractInstancePublishedEventPayload() {
21
11
  const path = getPathToFixture('ContractInstancePublishedEventData.hex');
22
12
  return Buffer.from(readFileSync(path).toString(), 'hex');
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@aztec/protocol-contracts",
3
3
  "homepage": "https://github.com/AztecProtocol/aztec-packages/tree/master/yarn-project/protocol-contracts",
4
4
  "description": "Canonical Noir contracts for the Aztec Network",
5
- "version": "0.0.1-commit.e3c1de76",
5
+ "version": "0.0.1-commit.e57c76e",
6
6
  "type": "module",
7
7
  "exports": {
8
8
  ".": "./dest/index.js",
@@ -73,9 +73,9 @@
73
73
  ]
74
74
  },
75
75
  "dependencies": {
76
- "@aztec/constants": "0.0.1-commit.e3c1de76",
77
- "@aztec/foundation": "0.0.1-commit.e3c1de76",
78
- "@aztec/stdlib": "0.0.1-commit.e3c1de76",
76
+ "@aztec/constants": "0.0.1-commit.e57c76e",
77
+ "@aztec/foundation": "0.0.1-commit.e57c76e",
78
+ "@aztec/stdlib": "0.0.1-commit.e57c76e",
79
79
  "lodash.chunk": "^4.2.0",
80
80
  "lodash.omit": "^4.5.0",
81
81
  "tslib": "^2.4.0"
@@ -4,7 +4,7 @@ import { FieldReader } from '@aztec/foundation/serialize';
4
4
  import { bufferFromFields } from '@aztec/stdlib/abi';
5
5
  import {
6
6
  type ContractClassPublic,
7
- computeContractClassId,
7
+ type ContractClassPublicWithCommitment,
8
8
  computePublicBytecodeCommitment,
9
9
  } from '@aztec/stdlib/contract';
10
10
  import type { ContractClassLog } from '@aztec/stdlib/logs';
@@ -47,34 +47,23 @@ export class ContractClassPublishedEvent {
47
47
  );
48
48
  }
49
49
 
50
- async toContractClassPublic(): Promise<ContractClassPublic> {
51
- const computedClassId = await computeContractClassId({
52
- artifactHash: this.artifactHash,
53
- privateFunctionsRoot: this.privateFunctionsRoot,
54
- publicBytecodeCommitment: await computePublicBytecodeCommitment(this.packedPublicBytecode),
55
- });
56
-
57
- if (!computedClassId.equals(this.contractClassId)) {
58
- throw new Error(
59
- `Invalid contract class id: computed ${computedClassId.toString()} but event broadcasted ${this.contractClassId.toString()}`,
60
- );
61
- }
62
-
63
- if (this.version !== 1) {
64
- throw new Error(`Unexpected contract class version ${this.version}`);
65
- }
66
-
50
+ /** Converts the event to a contract class, without computing or validating the bytecode commitment. */
51
+ toContractClassPublic(): ContractClassPublic {
67
52
  return {
68
53
  id: this.contractClassId,
69
54
  artifactHash: this.artifactHash,
70
55
  packedBytecode: this.packedPublicBytecode,
71
56
  privateFunctionsRoot: this.privateFunctionsRoot,
72
- version: this.version,
73
- privateFunctions: [],
74
- utilityFunctions: [],
57
+ version: this.version as 1,
75
58
  };
76
59
  }
77
60
 
61
+ /** Converts the event to a contract class with its bytecode commitment (expensive). */
62
+ async toContractClassPublicWithBytecodeCommitment(): Promise<ContractClassPublicWithCommitment> {
63
+ const publicBytecodeCommitment = await computePublicBytecodeCommitment(this.packedPublicBytecode);
64
+ return { ...this.toContractClassPublic(), publicBytecodeCommitment };
65
+ }
66
+
78
67
  public static extractContractClassEvents(logs: ContractClassLog[]): ContractClassPublishedEvent[] {
79
68
  return logs
80
69
  .filter((log: ContractClassLog) => ContractClassPublishedEvent.isContractClassPublishedEvent(log))
@@ -6,18 +6,16 @@ import { makeProtocolContract } from '../make_protocol_contract.js';
6
6
  import type { ProtocolContract } from '../protocol_contract.js';
7
7
 
8
8
  export * from './contract_class_published_event.js';
9
- export * from './private_function_broadcasted_event.js';
10
- export * from './utility_function_broadcasted_event.js';
11
9
 
12
10
  export const ContractClassRegistryArtifact = loadContractArtifact(ContractClassRegistryJson as NoirCompiledContract);
13
11
 
14
12
  let protocolContract: ProtocolContract;
15
13
 
16
14
  /** Returns the canonical deployment of the contract. */
17
- export async function getCanonicalClassRegistry(): Promise<ProtocolContract> {
15
+ export function getCanonicalClassRegistry(): Promise<ProtocolContract> {
18
16
  if (!protocolContract) {
19
17
  const artifact = ContractClassRegistryArtifact;
20
- protocolContract = await makeProtocolContract('ContractClassRegistry', artifact);
18
+ protocolContract = makeProtocolContract('ContractClassRegistry', artifact);
21
19
  }
22
- return protocolContract;
20
+ return Promise.resolve(protocolContract);
23
21
  }
@@ -4,8 +4,6 @@ import { makeProtocolContract } from '../make_protocol_contract.js';
4
4
  import type { ProtocolContract } from '../protocol_contract.js';
5
5
 
6
6
  export * from './contract_class_published_event.js';
7
- export * from './private_function_broadcasted_event.js';
8
- export * from './utility_function_broadcasted_event.js';
9
7
 
10
8
  let protocolContract: ProtocolContract;
11
9
  let protocolContractArtifact: ContractArtifact;
@@ -27,7 +25,7 @@ export async function getContractClassRegistryArtifact(): Promise<ContractArtifa
27
25
  export async function getCanonicalClassRegistry(): Promise<ProtocolContract> {
28
26
  if (!protocolContract) {
29
27
  const contractClassRegistryArtifact = await getContractClassRegistryArtifact();
30
- protocolContract = await makeProtocolContract('ContractClassRegistry', contractClassRegistryArtifact);
28
+ protocolContract = makeProtocolContract('ContractClassRegistry', contractClassRegistryArtifact);
31
29
  }
32
30
  return protocolContract;
33
31
  }
@@ -14,11 +14,11 @@ export const FeeJuiceArtifact = loadContractArtifact(FeeJuiceJson as NoirCompile
14
14
  let protocolContract: ProtocolContract;
15
15
 
16
16
  /** Returns the canonical deployment of the contract. */
17
- export async function getCanonicalFeeJuice(): Promise<ProtocolContract> {
17
+ export function getCanonicalFeeJuice(): Promise<ProtocolContract> {
18
18
  if (!protocolContract) {
19
- protocolContract = await makeProtocolContract('FeeJuice', FeeJuiceArtifact);
19
+ protocolContract = makeProtocolContract('FeeJuice', FeeJuiceArtifact);
20
20
  }
21
- return protocolContract;
21
+ return Promise.resolve(protocolContract);
22
22
  }
23
23
 
24
24
  /**
@@ -23,7 +23,7 @@ export async function getFeeJuiceArtifact(): Promise<ContractArtifact> {
23
23
  export async function getCanonicalFeeJuice(): Promise<ProtocolContract> {
24
24
  if (!protocolContract) {
25
25
  const feeJuiceArtifact = await getFeeJuiceArtifact();
26
- protocolContract = await makeProtocolContract('FeeJuice', feeJuiceArtifact);
26
+ protocolContract = makeProtocolContract('FeeJuice', feeJuiceArtifact);
27
27
  }
28
28
  return protocolContract;
29
29
  }
@@ -15,6 +15,7 @@ export class ContractInstancePublishedEvent {
15
15
  public readonly salt: Fr,
16
16
  public readonly contractClassId: Fr,
17
17
  public readonly initializationHash: Fr,
18
+ public readonly immutablesHash: Fr,
18
19
  public readonly publicKeys: PublicKeys,
19
20
  public readonly deployer: AztecAddress,
20
21
  ) {}
@@ -31,6 +32,7 @@ export class ContractInstancePublishedEvent {
31
32
  const salt = reader.readObject(Fr);
32
33
  const contractClassId = reader.readObject(Fr);
33
34
  const initializationHash = reader.readObject(Fr);
35
+ const immutablesHash = reader.readObject(Fr);
34
36
  const publicKeys = reader.readObject(PublicKeys);
35
37
  const deployer = reader.readObject(AztecAddress);
36
38
 
@@ -40,13 +42,14 @@ export class ContractInstancePublishedEvent {
40
42
  salt,
41
43
  contractClassId,
42
44
  initializationHash,
45
+ immutablesHash,
43
46
  publicKeys,
44
47
  deployer,
45
48
  );
46
49
  }
47
50
 
48
51
  toContractInstance(): ContractInstanceWithAddress {
49
- if (this.version !== 1) {
52
+ if (this.version !== 2) {
50
53
  throw new Error(`Unexpected contract instance version ${this.version}`);
51
54
  }
52
55
 
@@ -56,6 +59,7 @@ export class ContractInstancePublishedEvent {
56
59
  currentContractClassId: this.contractClassId,
57
60
  originalContractClassId: this.contractClassId,
58
61
  initializationHash: this.initializationHash,
62
+ immutablesHash: this.immutablesHash,
59
63
  publicKeys: this.publicKeys,
60
64
  salt: this.salt,
61
65
  deployer: this.deployer,
@@ -15,9 +15,9 @@ export const ContractInstanceRegistryArtifact = loadContractArtifact(
15
15
  let protocolContract: ProtocolContract;
16
16
 
17
17
  /** Returns the canonical deployment of the contract. */
18
- export async function getCanonicalInstanceRegistry(): Promise<ProtocolContract> {
18
+ export function getCanonicalInstanceRegistry(): Promise<ProtocolContract> {
19
19
  if (!protocolContract) {
20
- protocolContract = await makeProtocolContract('ContractInstanceRegistry', ContractInstanceRegistryArtifact);
20
+ protocolContract = makeProtocolContract('ContractInstanceRegistry', ContractInstanceRegistryArtifact);
21
21
  }
22
- return protocolContract;
22
+ return Promise.resolve(protocolContract);
23
23
  }
@@ -26,7 +26,7 @@ export async function getContractInstanceRegistryArtifact(): Promise<ContractArt
26
26
  export async function getCanonicalInstanceRegistry(): Promise<ProtocolContract> {
27
27
  if (!protocolContract) {
28
28
  const contractInstanceRegistryArtifact = await getContractInstanceRegistryArtifact();
29
- protocolContract = await makeProtocolContract('ContractInstanceRegistry', contractInstanceRegistryArtifact);
29
+ protocolContract = makeProtocolContract('ContractInstanceRegistry', contractInstanceRegistryArtifact);
30
30
  }
31
31
  return protocolContract;
32
32
  }
@@ -1,26 +1,50 @@
1
+ import { Fr } from '@aztec/foundation/curves/bn254';
1
2
  import type { ContractArtifact } from '@aztec/stdlib/abi';
2
- import { getContractClassFromArtifact, getContractInstanceFromInstantiationParams } from '@aztec/stdlib/contract';
3
+ import { PublicKeys } from '@aztec/stdlib/keys';
3
4
 
4
5
  import type { ProtocolContract } from './protocol_contract.js';
5
- import { ProtocolContractAddress, type ProtocolContractName, ProtocolContractSalt } from './protocol_contract_data.js';
6
+ import {
7
+ ProtocolContractAddress,
8
+ ProtocolContractClassId,
9
+ ProtocolContractClassIdPreimage,
10
+ ProtocolContractInitializationHash,
11
+ type ProtocolContractName,
12
+ ProtocolContractPrivateFunctions,
13
+ ProtocolContractSalt,
14
+ } from './protocol_contract_data.js';
6
15
 
7
16
  /**
8
- * Returns the canonical deployment given its name and artifact.
9
- * To be used internally within the protocol-contracts package.
17
+ * Reconstructs a ProtocolContract from precomputed data without performing any hash computations.
18
+ * Internal to the protocol-contracts package — not part of the public API.
10
19
  */
11
- export async function makeProtocolContract(
12
- name: ProtocolContractName,
13
- artifact: ContractArtifact,
14
- ): Promise<ProtocolContract> {
20
+ export function makeProtocolContract(name: ProtocolContractName, artifact: ContractArtifact): ProtocolContract {
15
21
  const address = ProtocolContractAddress[name];
16
22
  const salt = ProtocolContractSalt[name];
17
- // TODO(@spalladino): This computes the contract class from the artifact twice.
18
- const contractClass = await getContractClassFromArtifact(artifact);
19
- const instance = await getContractInstanceFromInstantiationParams(artifact, { salt });
20
- return {
21
- instance: { ...instance, address },
22
- contractClass,
23
- artifact,
23
+ const classId = ProtocolContractClassId[name];
24
+ const { artifactHash, privateFunctionsRoot, publicBytecodeCommitment } = ProtocolContractClassIdPreimage[name];
25
+ const initializationHash = ProtocolContractInitializationHash[name];
26
+
27
+ const contractClass = {
28
+ id: classId,
29
+ version: 1 as const,
30
+ artifactHash,
31
+ privateFunctionsRoot,
32
+ publicBytecodeCommitment,
33
+ packedBytecode: artifact.functions.find(f => f.name === 'public_dispatch')?.bytecode ?? Buffer.alloc(0),
34
+ privateFunctions: ProtocolContractPrivateFunctions[name],
35
+ };
36
+
37
+ const instance = {
38
+ version: 2 as const,
39
+ currentContractClassId: classId,
40
+ originalContractClassId: classId,
41
+ initializationHash,
42
+ immutablesHash: Fr.ZERO, // Protocol Contracts Have No Immutables
43
+ publicKeys: PublicKeys.default(),
44
+ salt,
45
+ deployer: address,
24
46
  address,
25
47
  };
48
+
49
+ return { instance, contractClass, artifact, address };
26
50
  }
@@ -1,17 +1,15 @@
1
1
 
2
2
  // GENERATED FILE - DO NOT EDIT. RUN `yarn generate` or `yarn generate:data`
3
3
  import { Fr } from '@aztec/foundation/curves/bn254';
4
+ import { FunctionSelector } from '@aztec/stdlib/abi';
4
5
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
5
6
  import { ProtocolContracts } from '@aztec/stdlib/tx';
6
7
 
7
8
 
8
9
  export const protocolContractNames = [
9
- 'AuthRegistry',
10
- 'ContractInstanceRegistry',
10
+ 'ContractInstanceRegistry',
11
11
  'ContractClassRegistry',
12
- 'MultiCallEntrypoint',
13
- 'FeeJuice',
14
- 'PublicChecks'
12
+ 'FeeJuice'
15
13
  ] as const;
16
14
 
17
15
  export type ProtocolContractName = typeof protocolContractNames[number];
@@ -19,45 +17,74 @@
19
17
 
20
18
 
21
19
  export const ProtocolContractSalt: Record<ProtocolContractName, Fr> = {
22
- AuthRegistry: new Fr(1),
23
- ContractInstanceRegistry: new Fr(1),
20
+ ContractInstanceRegistry: new Fr(1),
24
21
  ContractClassRegistry: new Fr(1),
25
- MultiCallEntrypoint: new Fr(1),
26
- FeeJuice: new Fr(1),
27
- PublicChecks: new Fr(1)
22
+ FeeJuice: new Fr(1)
28
23
  };
29
24
 
30
25
 
31
26
 
32
27
  export const ProtocolContractAddress: Record<ProtocolContractName, AztecAddress> = {
33
- AuthRegistry: AztecAddress.fromBigInt(1n),
34
- ContractInstanceRegistry: AztecAddress.fromBigInt(2n),
35
- ContractClassRegistry: AztecAddress.fromBigInt(3n),
36
- MultiCallEntrypoint: AztecAddress.fromBigInt(4n),
37
- FeeJuice: AztecAddress.fromBigInt(5n),
38
- PublicChecks: AztecAddress.fromBigInt(6n)
28
+ ContractInstanceRegistry: AztecAddress.fromBigInt(2n),
29
+ ContractClassRegistry: AztecAddress.fromBigInt(1n),
30
+ FeeJuice: AztecAddress.fromBigInt(3n)
39
31
  };
40
32
 
41
33
 
42
34
 
43
35
  export const ProtocolContractDerivedAddress = {
44
- AuthRegistry: AztecAddress.fromString('0x0d3d0e71f86606d6894274896438a8b7240fe5b21472b88d08ad8d7dab408d6e'),
45
- ContractInstanceRegistry: AztecAddress.fromString('0x0da899f8f78d98c89757e0af3e8714511256679d17f97b4fbbd4e1d64cdb2d7c'),
46
- ContractClassRegistry: AztecAddress.fromString('0x0f42f3344a38a33a22ad93d490c9286e1478c9b829fdada7d2fedbb2cb6da363'),
47
- MultiCallEntrypoint: AztecAddress.fromString('0x2eaa319fb7d5f8ce54daa7322251374b5845189bfa907b53a9a3a8914d05520b'),
48
- FeeJuice: AztecAddress.fromString('0x046a5771b3aec1b17d8e7700c4f26b466f4e5b5409f8d9c94cf81373db4eb4e8'),
49
- PublicChecks: AztecAddress.fromString('0x09234f39c502e335237149623d721d16cb5616ade2a2de33f57afe16921724d4')
36
+ ContractInstanceRegistry: AztecAddress.fromString('0x290f7bf7cea0eb4c440a06dc8bcf825865479348c9ebf8f540b10ad10fd32c44'),
37
+ ContractClassRegistry: AztecAddress.fromString('0x20b16259faa0a096d687572fc76221263f1cad4a4b726ef49e2cd7b7ce7c7465'),
38
+ FeeJuice: AztecAddress.fromString('0x0fa3ba3e01e6646cd2adade41018dbfff04e59c444760e33bf773ec43d683019')
39
+ };
40
+
41
+
42
+
43
+ export const ProtocolContractClassId: Record<ProtocolContractName, Fr> = {
44
+ ContractInstanceRegistry: Fr.fromString('0x123597d7f3c460a3e91bfb92e729fcd048d4f50a88b7c25e694cf75827062e3f'),
45
+ ContractClassRegistry: Fr.fromString('0x243b6ce1af8f520d531b26ce5081fa29c0870ce8d5949c5304a6705b07947a2e'),
46
+ FeeJuice: Fr.fromString('0x1f65e3db036c48ac8f8635b156880ed17e9437ed8904a0c0554f0d6251bf0997')
47
+ };
48
+
49
+ export const ProtocolContractClassIdPreimage: Record<ProtocolContractName, { artifactHash: Fr; privateFunctionsRoot: Fr; publicBytecodeCommitment: Fr }> = {
50
+ ContractInstanceRegistry: {
51
+ artifactHash: Fr.fromString('0x0cb37c0b0ec8670b88b472fca5858f8cb112a41ba2aad664903ac1a3bed468b3'),
52
+ privateFunctionsRoot: Fr.fromString('0x0239b0f293384aad456e2e27901eb97cd9073322a28d14b0ac7816a5297b2812'),
53
+ publicBytecodeCommitment: Fr.fromString('0x2c79b6699098244e947caca071a31799c20aa20e7124910a2b7c918fe817d65e'),
54
+ },
55
+ ContractClassRegistry: {
56
+ artifactHash: Fr.fromString('0x1e252471ee2b770fba961d03289344f1798336d9a94e1d8f137397754708de0e'),
57
+ privateFunctionsRoot: Fr.fromString('0x0672f623ec0753ab9fbb02a9a241df81b9bcc0dbed8628d8cab8790e0cb0c03d'),
58
+ publicBytecodeCommitment: Fr.fromString('0x0ce4c618c3ed7f3a20410e618c06bb701e150af7fe28a3e92f68e7733809f33e'),
59
+ },
60
+ FeeJuice: {
61
+ artifactHash: Fr.fromString('0x1243f24c1d3e8b42c900aa95d3a12448d84f8b5da3fe047f8ac8a46e67bb10b7'),
62
+ privateFunctionsRoot: Fr.fromString('0x247aaafc67f6bf5b06736649181a477dac9f18d3468969b14669708c3dabb275'),
63
+ publicBytecodeCommitment: Fr.fromString('0x1d4b1a8f71b8250d4fb65f8e16a4604e9165648279f47d80e024ce2684c4bdfb'),
64
+ }
65
+ };
66
+
67
+ export const ProtocolContractInitializationHash: Record<ProtocolContractName, Fr> = {
68
+ ContractInstanceRegistry: Fr.fromString('0x0000000000000000000000000000000000000000000000000000000000000000'),
69
+ ContractClassRegistry: Fr.fromString('0x0000000000000000000000000000000000000000000000000000000000000000'),
70
+ FeeJuice: Fr.fromString('0x0000000000000000000000000000000000000000000000000000000000000000')
71
+ };
72
+
73
+ export const ProtocolContractPrivateFunctions: Record<ProtocolContractName, { selector: FunctionSelector; vkHash: Fr }[]> = {
74
+ ContractInstanceRegistry: [{ selector: FunctionSelector.fromField(Fr.fromString('0x0000000000000000000000000000000000000000000000000000000077cff62f')), vkHash: Fr.fromString('0x08a57d0b4d164c6c8d92da9c3bfe57a4ac1a639ab0a2a0ccb60bbb6bcd37f245') }],
75
+ ContractClassRegistry: [{ selector: FunctionSelector.fromField(Fr.fromString('0x000000000000000000000000000000000000000000000000000000006934ed0d')), vkHash: Fr.fromString('0x1531ed0e20d6d05f1aeb06f746c8c4b8f467174836d6edf915b0c45099b393ed') }],
76
+ FeeJuice: [{ selector: FunctionSelector.fromField(Fr.fromString('0x00000000000000000000000000000000000000000000000000000000cbe67243')), vkHash: Fr.fromString('0x2dbad42bf59fe7ea908485dea59573b4d7fb8ddefb6a0f73bbcce79aa27d545c') }, { selector: FunctionSelector.fromField(Fr.fromString('0x00000000000000000000000000000000000000000000000000000000e8d374b6')), vkHash: Fr.fromString('0x2e9880e15fb0c9a5494faef915861144769e94aded54c737819ee75918fbda51') }]
50
77
  };
51
78
 
52
79
 
53
80
 
54
81
  export const ProtocolContractsList = new ProtocolContracts([
55
- AztecAddress.fromString('0x0d3d0e71f86606d6894274896438a8b7240fe5b21472b88d08ad8d7dab408d6e'),
56
- AztecAddress.fromString('0x0da899f8f78d98c89757e0af3e8714511256679d17f97b4fbbd4e1d64cdb2d7c'),
57
- AztecAddress.fromString('0x0f42f3344a38a33a22ad93d490c9286e1478c9b829fdada7d2fedbb2cb6da363'),
58
- AztecAddress.fromString('0x2eaa319fb7d5f8ce54daa7322251374b5845189bfa907b53a9a3a8914d05520b'),
59
- AztecAddress.fromString('0x046a5771b3aec1b17d8e7700c4f26b466f4e5b5409f8d9c94cf81373db4eb4e8'),
60
- AztecAddress.fromString('0x09234f39c502e335237149623d721d16cb5616ade2a2de33f57afe16921724d4'),
82
+ AztecAddress.fromString('0x20b16259faa0a096d687572fc76221263f1cad4a4b726ef49e2cd7b7ce7c7465'),
83
+ AztecAddress.fromString('0x290f7bf7cea0eb4c440a06dc8bcf825865479348c9ebf8f540b10ad10fd32c44'),
84
+ AztecAddress.fromString('0x0fa3ba3e01e6646cd2adade41018dbfff04e59c444760e33bf773ec43d683019'),
85
+ AztecAddress.fromString('0x0000000000000000000000000000000000000000000000000000000000000000'),
86
+ AztecAddress.fromString('0x0000000000000000000000000000000000000000000000000000000000000000'),
87
+ AztecAddress.fromString('0x0000000000000000000000000000000000000000000000000000000000000000'),
61
88
  AztecAddress.fromString('0x0000000000000000000000000000000000000000000000000000000000000000'),
62
89
  AztecAddress.fromString('0x0000000000000000000000000000000000000000000000000000000000000000'),
63
90
  AztecAddress.fromString('0x0000000000000000000000000000000000000000000000000000000000000000'),
@@ -65,10 +92,10 @@ AztecAddress.fromString('0x00000000000000000000000000000000000000000000000000000
65
92
  AztecAddress.fromString('0x0000000000000000000000000000000000000000000000000000000000000000')
66
93
  ]);
67
94
 
68
- export const protocolContractsHash = Fr.fromString('0x2fb23afc4e9922d7b01441a3ad930fc3bf8060b79a013ee45b8cedc549d6b428');
95
+ export const protocolContractsHash = Fr.fromString('0x04194c6dd98d175d07d300b253a9967f5c46782d0e9c3c88473f79ca8b8b16d6');
69
96
 
70
97
 
71
98
 
72
- export const CONTRACT_INSTANCE_PUBLISHED_EVENT_TAG = Fr.fromHexString('0x1fac4c16bff9365b079923d46d85c86b4fcbb5c67c5c65febe8596599412b0ee');
99
+ export const CONTRACT_INSTANCE_PUBLISHED_EVENT_TAG = Fr.fromHexString('0x1a7e1badb79abdd38c684b3c8306ffe7ecb33c69e3380d9855730aaaa83a21a8');
73
100
 
74
101