@aztec/protocol-contracts 0.57.0 → 0.59.0

package/src/router/index.ts

@@ -1,22 +1,6 @@
-import { AztecAddress, ROUTER_ADDRESS } from '@aztec/circuits.js';
-
 import { type ProtocolContract, getCanonicalProtocolContract } from '../protocol_contract.js';
-import { RouterArtifact } from './artifact.js';
 
 /** Returns the canonical deployment of the router. */
 export function getCanonicalRouter(): ProtocolContract {
-  const contract = getCanonicalProtocolContract(RouterArtifact, 1);
-
-  if (!contract.address.equals(RouterAddress)) {
-    throw new Error(
-      `Incorrect address for router (got ${contract.address.toString()} but expected ${RouterAddress.toString()}). Check ROUTER_ADDRESS is set to the correct value in the constants files and run the protocol-contracts package tests.`,
-    );
-  }
-  return contract;
+  return getCanonicalProtocolContract('Router');
 }
-
-export function getCanonicalRouterAddress(): AztecAddress {
-  return getCanonicalRouter().address;
-}
-
-export const RouterAddress = AztecAddress.fromBigInt(ROUTER_ADDRESS);

package/src/scripts/generate_data.ts

@@ -0,0 +1,208 @@
+import {
+  CANONICAL_AUTH_REGISTRY_ADDRESS,
+  DEPLOYER_CONTRACT_ADDRESS,
+  FEE_JUICE_ADDRESS,
+  Fr,
+  MULTI_CALL_ENTRYPOINT_ADDRESS,
+  REGISTERER_CONTRACT_ADDRESS,
+  ROUTER_ADDRESS,
+  getContractInstanceFromDeployParams,
+} from '@aztec/circuits.js';
+import { createConsoleLogger } from '@aztec/foundation/log';
+import { loadContractArtifact } from '@aztec/types/abi';
+import { type NoirCompiledContract } from '@aztec/types/noir';
+
+import fs from 'fs/promises';
+import path from 'path';
+
+import { buildProtocolContractTree } from '../build_protocol_contract_tree.js';
+
+const log = createConsoleLogger('aztec:autogenerate');
+
+const noirContractsRoot = '../../noir-projects/noir-contracts';
+const srcPath = path.join(noirContractsRoot, './target');
+const destArtifactsDir = './artifacts';
+const outputFilePath = './src/protocol_contract_data.ts';
+
+const salt = new Fr(1);
+
+const contractAddressMapping: { [name: string]: number } = {
+  AuthRegistry: CANONICAL_AUTH_REGISTRY_ADDRESS,
+  ContractInstanceDeployer: DEPLOYER_CONTRACT_ADDRESS,
+  ContractClassRegisterer: REGISTERER_CONTRACT_ADDRESS,
+  MultiCallEntrypoint: MULTI_CALL_ENTRYPOINT_ADDRESS,
+  FeeJuice: FEE_JUICE_ADDRESS,
+  Router: ROUTER_ADDRESS,
+};
+
+async function clearDestDir() {
+  try {
+    await fs.access(destArtifactsDir);
+    // If the directory exists, remove it recursively.
+    await fs.rm(destArtifactsDir, { recursive: true, force: true });
+  } catch (err: any) {
+    if (err.code === 'ENOENT') {
+      // If the directory does not exist, do nothing.
+    } else {
+      log(`Error removing dest directory: ${err}`);
+    }
+  }
+  await fs.mkdir(destArtifactsDir, { recursive: true });
+}
+
+function getPrivateFunctionNames(artifact: NoirCompiledContract) {
+  return artifact.functions.filter(fn => fn.custom_attributes.includes('private')).map(fn => fn.name);
+}
+
+async function copyArtifact(srcName: string, destName: string) {
+  const src = path.join(srcPath, `${srcName}.json`);
+  const artifact = JSON.parse(await fs.readFile(src, 'utf8')) as NoirCompiledContract;
+  const dest = path.join(destArtifactsDir, `${destName}.json`);
+  await fs.copyFile(src, dest);
+  return artifact;
+}
+
+async function copyVks(srcName: string, destName: string, fnNames: string[]) {
+  const deskVksDir = path.join(destArtifactsDir, 'keys', destName);
+  await fs.mkdir(deskVksDir, { recursive: true });
+
+  for (const fnName of fnNames) {
+    const src = path.join(srcPath, 'keys', `${srcName}-${fnName}.vk.data.json`);
+    const dest = path.join(deskVksDir, `${fnName}.vk.data.json`);
+    await fs.copyFile(src, dest);
+  }
+}
+
+function computeContractLeaf(artifact: NoirCompiledContract) {
+  const instance = getContractInstanceFromDeployParams(loadContractArtifact(artifact), { salt });
+  return instance.address;
+}
+
+function computeRoot(names: string[], leaves: Fr[]) {
+  const data = names.map((name, i) => ({ address: new Fr(contractAddressMapping[name]), leaf: leaves[i] }));
+  const tree = buildProtocolContractTree(data);
+  return Fr.fromBuffer(tree.root);
+}
+
+async function generateDeclarationFile(destName: string) {
+  const content = `
+    import { type NoirCompiledContract } from '@aztec/types/noir';
+    const circuit: NoirCompiledContract;
+    export = circuit;
+  `;
+  await fs.writeFile(path.join(destArtifactsDir, `${destName}.d.json.ts`), content);
+}
+
+function generateNames(names: string[]) {
+  return `
+    export const protocolContractNames = [
+      ${names.map(name => `'${name}'`).join(',\n')}
+    ] as const;
+
+    export type ProtocolContractName = typeof protocolContractNames[number];
+  `;
+}
+
+function generateArtifacts(names: string[]) {
+  const imports = names
+    .map(name => {
+      return `
+      import ${name}Json from '../artifacts/${name}.json' assert { type: 'json' };
+    `;
+    })
+    .join('\n');
+
+  const exports = names.map(name => `${name}: loadContractArtifact(${name}Json as NoirCompiledContract)`).join(',\n');
+
+  return `
+    ${imports}
+
+    export const ProtocolContractArtifact: Record<ProtocolContractName, ContractArtifact> = {
+      ${exports}
+    };
+  `;
+}
+
+function generateSalts(names: string[]) {
+  return `
+    export const ProtocolContractSalt: Record<ProtocolContractName, Fr> = {
+      ${names.map(name => `${name}: new Fr(${salt.toNumber()})`).join(',\n')}
+    };
+  `;
+}
+
+function generateContractAddresses(names: string[]) {
+  const addresses = names.map(name => `${name}: AztecAddress.fromBigInt(${contractAddressMapping[name]}n)`).join(',\n');
+  return `
+    export const ProtocolContractAddress: Record<ProtocolContractName, AztecAddress> = {
+      ${addresses}
+    };
+  `;
+}
+
+function generateContractLeaves(names: string[], leaves: Fr[]) {
+  return `
+    export const ProtocolContractLeaf = {
+      ${leaves.map((leaf, i) => `${names[i]}: Fr.fromString('${leaf.toString()}')`).join(',\n')}
+    };
+  `;
+}
+
+function generateRoot(names: string[], leaves: Fr[]) {
+  const root = computeRoot(names, leaves);
+  return `
+    export const protocolContractTreeRoot = Fr.fromString('${root.toString()}');
+  `;
+}
+
+async function generateOutputFile(names: string[], leaves: Fr[]) {
+  const content = `
+    // GENERATED FILE - DO NOT EDIT. RUN \`yarn generate\` or \`yarn generate:data\`
+    import { AztecAddress, Fr } from '@aztec/circuits.js';
+    import { type ContractArtifact } from '@aztec/foundation/abi';
+    import { loadContractArtifact } from '@aztec/types/abi';
+    import { type NoirCompiledContract } from '@aztec/types/noir';
+
+    ${generateNames(names)}
+
+    ${generateArtifacts(names)}
+
+    ${generateSalts(names)}
+
+    ${generateContractAddresses(names)}
+
+    ${generateContractLeaves(names, leaves)}
+
+    ${generateRoot(names, leaves)}
+  `;
+  await fs.writeFile(outputFilePath, content);
+}
+
+async function main() {
+  await clearDestDir();
+
+  const srcNames = JSON.parse(
+    await fs.readFile(path.join(noirContractsRoot, 'protocol_contracts.json'), 'utf8'),
+  ) as string[];
+
+  const leaves = [];
+  const destNames = srcNames.map(n => n.split('-')[1]);
+  for (let i = 0; i < srcNames.length; i++) {
+    const srcName = srcNames[i];
+    const destName = destNames[i];
+    const artifact = await copyArtifact(srcName, destName);
+    const fnNames = getPrivateFunctionNames(artifact);
+    await copyVks(srcName, destName, fnNames);
+    await generateDeclarationFile(destName);
+    leaves.push(computeContractLeaf(artifact));
+  }
+
+  await generateOutputFile(destNames, leaves);
+}
+
+try {
+  await main();
+} catch (err: unknown) {
+  log(`Error copying protocol contract artifacts: ${err}`);
+  process.exit(1);
+}

package/dest/auth-registry/artifact.d.ts

@@ -1,2 +0,0 @@
-export declare const AuthRegistryArtifact: import("@aztec/foundation/abi").ContractArtifact;
-//# sourceMappingURL=artifact.d.ts.map

package/dest/auth-registry/artifact.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"artifact.d.ts","sourceRoot":"","sources":["../../src/auth-registry/artifact.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,oBAAoB,kDAAiE,CAAC"}

package/dest/auth-registry/artifact.js

@@ -1,4 +0,0 @@
-import { loadContractArtifact } from '@aztec/types/abi';
-import AuthRegistryJson from '../../artifacts/AuthRegistry.json' assert { type: 'json' };
-export const AuthRegistryArtifact = loadContractArtifact(AuthRegistryJson);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJ0aWZhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYXV0aC1yZWdpc3RyeS9hcnRpZmFjdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsb0JBQW9CLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUd4RCxPQUFPLGdCQUFnQixNQUFNLG1DQUFtQyxDQUFDLFNBQVMsSUFBSSxFQUFFLE1BQU0sRUFBRSxDQUFDO0FBRXpGLE1BQU0sQ0FBQyxNQUFNLG9CQUFvQixHQUFHLG9CQUFvQixDQUFDLGdCQUF3QyxDQUFDLENBQUMifQ==

package/dest/class-registerer/artifact.d.ts

@@ -1,2 +0,0 @@
-export declare const ContractClassRegistererArtifact: import("@aztec/foundation/abi").ContractArtifact;
-//# sourceMappingURL=artifact.d.ts.map

package/dest/class-registerer/artifact.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"artifact.d.ts","sourceRoot":"","sources":["../../src/class-registerer/artifact.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,+BAA+B,kDAE3C,CAAC"}

package/dest/class-registerer/artifact.js

@@ -1,4 +0,0 @@
-import { loadContractArtifact } from '@aztec/types/abi';
-import ContractClassRegistererJson from '../../artifacts/ContractClassRegisterer.json' assert { type: 'json' };
-export const ContractClassRegistererArtifact = loadContractArtifact(ContractClassRegistererJson);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJ0aWZhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xhc3MtcmVnaXN0ZXJlci9hcnRpZmFjdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsb0JBQW9CLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUd4RCxPQUFPLDJCQUEyQixNQUFNLDhDQUE4QyxDQUFDLFNBQVMsSUFBSSxFQUFFLE1BQU0sRUFBRSxDQUFDO0FBRS9HLE1BQU0sQ0FBQyxNQUFNLCtCQUErQixHQUFHLG9CQUFvQixDQUNqRSwyQkFBbUQsQ0FDcEQsQ0FBQyJ9

package/dest/fee-juice/artifact.d.ts

@@ -1,2 +0,0 @@
-export declare const FeeJuiceArtifact: import("@aztec/foundation/abi").ContractArtifact;
-//# sourceMappingURL=artifact.d.ts.map

package/dest/fee-juice/artifact.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"artifact.d.ts","sourceRoot":"","sources":["../../src/fee-juice/artifact.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,gBAAgB,kDAA6D,CAAC"}

package/dest/fee-juice/artifact.js

@@ -1,4 +0,0 @@
-import { loadContractArtifact } from '@aztec/types/abi';
-import FeeJuiceJson from '../../artifacts/FeeJuice.json' assert { type: 'json' };
-export const FeeJuiceArtifact = loadContractArtifact(FeeJuiceJson);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJ0aWZhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZmVlLWp1aWNlL2FydGlmYWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBR3hELE9BQU8sWUFBWSxNQUFNLCtCQUErQixDQUFDLFNBQVMsSUFBSSxFQUFFLE1BQU0sRUFBRSxDQUFDO0FBRWpGLE1BQU0sQ0FBQyxNQUFNLGdCQUFnQixHQUFHLG9CQUFvQixDQUFDLFlBQW9DLENBQUMsQ0FBQyJ9

package/dest/instance-deployer/artifact.d.ts

@@ -1,2 +0,0 @@
-export declare const ContractInstanceDeployerArtifact: import("@aztec/foundation/abi").ContractArtifact;
-//# sourceMappingURL=artifact.d.ts.map

package/dest/instance-deployer/artifact.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"artifact.d.ts","sourceRoot":"","sources":["../../src/instance-deployer/artifact.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,gCAAgC,kDAE5C,CAAC"}

package/dest/instance-deployer/artifact.js

@@ -1,4 +0,0 @@
-import { loadContractArtifact } from '@aztec/types/abi';
-import ContractInstanceDeployerJson from '../../artifacts/ContractInstanceDeployer.json' assert { type: 'json' };
-export const ContractInstanceDeployerArtifact = loadContractArtifact(ContractInstanceDeployerJson);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJ0aWZhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5zdGFuY2UtZGVwbG95ZXIvYXJ0aWZhY3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLG9CQUFvQixFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFHeEQsT0FBTyw0QkFBNEIsTUFBTSwrQ0FBK0MsQ0FBQyxTQUFTLElBQUksRUFBRSxNQUFNLEVBQUUsQ0FBQztBQUVqSCxNQUFNLENBQUMsTUFBTSxnQ0FBZ0MsR0FBRyxvQkFBb0IsQ0FDbEUsNEJBQW9ELENBQ3JELENBQUMifQ==

package/dest/multi-call-entrypoint/artifact.d.ts

@@ -1,2 +0,0 @@
-export declare const MultiCallEntrypointArtifact: import("@aztec/foundation/abi").ContractArtifact;
-//# sourceMappingURL=artifact.d.ts.map

package/dest/multi-call-entrypoint/artifact.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"artifact.d.ts","sourceRoot":"","sources":["../../src/multi-call-entrypoint/artifact.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,2BAA2B,kDAAoE,CAAC"}

package/dest/multi-call-entrypoint/artifact.js

@@ -1,4 +0,0 @@
-import { loadContractArtifact } from '@aztec/types/abi';
-import MultiCallEntrypoint from '../../artifacts/MultiCallEntrypoint.json' assert { type: 'json' };
-export const MultiCallEntrypointArtifact = loadContractArtifact(MultiCallEntrypoint);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJ0aWZhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbXVsdGktY2FsbC1lbnRyeXBvaW50L2FydGlmYWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBR3hELE9BQU8sbUJBQW1CLE1BQU0sMENBQTBDLENBQUMsU0FBUyxJQUFJLEVBQUUsTUFBTSxFQUFFLENBQUM7QUFFbkcsTUFBTSxDQUFDLE1BQU0sMkJBQTJCLEdBQUcsb0JBQW9CLENBQUMsbUJBQTJDLENBQUMsQ0FBQyJ9

package/dest/router/artifact.d.ts

@@ -1,2 +0,0 @@
-export declare const RouterArtifact: import("@aztec/foundation/abi").ContractArtifact;
-//# sourceMappingURL=artifact.d.ts.map

package/dest/router/artifact.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"artifact.d.ts","sourceRoot":"","sources":["../../src/router/artifact.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,cAAc,kDAA2D,CAAC"}

package/dest/router/artifact.js

@@ -1,4 +0,0 @@
-import { loadContractArtifact } from '@aztec/types/abi';
-import RouterJson from '../../artifacts/Router.json' assert { type: 'json' };
-export const RouterArtifact = loadContractArtifact(RouterJson);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJ0aWZhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvcm91dGVyL2FydGlmYWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBR3hELE9BQU8sVUFBVSxNQUFNLDZCQUE2QixDQUFDLFNBQVMsSUFBSSxFQUFFLE1BQU0sRUFBRSxDQUFDO0FBRTdFLE1BQU0sQ0FBQyxNQUFNLGNBQWMsR0FBRyxvQkFBb0IsQ0FBQyxVQUFrQyxDQUFDLENBQUMifQ==

package/src/auth-registry/artifact.ts

@@ -1,6 +0,0 @@
-import { loadContractArtifact } from '@aztec/types/abi';
-import { type NoirCompiledContract } from '@aztec/types/noir';
-
-import AuthRegistryJson from '../../artifacts/AuthRegistry.json' assert { type: 'json' };
-
-export const AuthRegistryArtifact = loadContractArtifact(AuthRegistryJson as NoirCompiledContract);

package/src/class-registerer/artifact.ts

@@ -1,8 +0,0 @@
-import { loadContractArtifact } from '@aztec/types/abi';
-import { type NoirCompiledContract } from '@aztec/types/noir';
-
-import ContractClassRegistererJson from '../../artifacts/ContractClassRegisterer.json' assert { type: 'json' };
-
-export const ContractClassRegistererArtifact = loadContractArtifact(
-  ContractClassRegistererJson as NoirCompiledContract,
-);

package/src/fee-juice/artifact.ts

@@ -1,6 +0,0 @@
-import { loadContractArtifact } from '@aztec/types/abi';
-import { type NoirCompiledContract } from '@aztec/types/noir';
-
-import FeeJuiceJson from '../../artifacts/FeeJuice.json' assert { type: 'json' };
-
-export const FeeJuiceArtifact = loadContractArtifact(FeeJuiceJson as NoirCompiledContract);

package/src/instance-deployer/artifact.ts

@@ -1,8 +0,0 @@
-import { loadContractArtifact } from '@aztec/types/abi';
-import { type NoirCompiledContract } from '@aztec/types/noir';
-
-import ContractInstanceDeployerJson from '../../artifacts/ContractInstanceDeployer.json' assert { type: 'json' };
-
-export const ContractInstanceDeployerArtifact = loadContractArtifact(
-  ContractInstanceDeployerJson as NoirCompiledContract,
-);

package/src/multi-call-entrypoint/artifact.ts

@@ -1,6 +0,0 @@
-import { loadContractArtifact } from '@aztec/types/abi';
-import { type NoirCompiledContract } from '@aztec/types/noir';
-
-import MultiCallEntrypoint from '../../artifacts/MultiCallEntrypoint.json' assert { type: 'json' };
-
-export const MultiCallEntrypointArtifact = loadContractArtifact(MultiCallEntrypoint as NoirCompiledContract);

package/src/router/artifact.ts

@@ -1,6 +0,0 @@
-import { loadContractArtifact } from '@aztec/types/abi';
-import { type NoirCompiledContract } from '@aztec/types/noir';
-
-import RouterJson from '../../artifacts/Router.json' assert { type: 'json' };
-
-export const RouterArtifact = loadContractArtifact(RouterJson as NoirCompiledContract);