refactor(standard-contracts): mirror protocol-contracts pattern with shared infra

Author: dbanks12

noir-projects/aztec-nr/standard_addresses/src/auth_registry.nr

@@ -1,11 +1,6 @@
-// Aggregator module for standard contract address stamps.
-//
-// Each submodule is generated by a script under
-// `yarn-project/standard-contracts/src/scripts/`. The hand-written
-// re-exports here keep downstream consumers using flat
-// `standard_addresses::FOO_ADDRESS` paths regardless of where the
-// stamp is generated.
+// GENERATED FILE - DO NOT EDIT. RUN `yarn workspace @aztec/standard-contracts run generate`.
+use protocol_types::{address::AztecAddress, traits::FromField};
 
-pub mod auth_registry;
-
-pub use auth_registry::AUTH_REGISTRY_ADDRESS;
+pub global AUTH_REGISTRY_ADDRESS: AztecAddress = AztecAddress::from_field(
+    0x1f7f0c3d878160356b2025b056a7a390ab34bd17f2ba4320ffb4a71698d5bf3a,
+);

noir-projects/aztec-nr/standard_addresses/src/lib.nr

@@ -8,7 +8,7 @@
     ".": "./dest/index.js",
     "./*": "./dest/*/index.js",
     "./*/lazy": "./dest/*/lazy.js",
-    "./auth-registry/address": "./dest/auth-registry/address.gen.js"
+    "./*/address": "./dest/*/address.js"
   },
   "typedocOptions": {
     "entryPoints": [
@@ -24,7 +24,6 @@
     "generate": "yarn generate:data",
     "generate:cleanup-artifacts": "node --no-warnings --loader @swc-node/register/esm src/scripts/cleanup_artifacts.ts",
     "generate:data": "node --no-warnings --loader @swc-node/register/esm src/scripts/generate_data.ts",
-    "regen:auth-registry-address": "node --experimental-vm-modules dest/scripts/derive_auth_registry.js",
     "build:dev": "../scripts/tsc.sh --watch",
     "build:ts": "../scripts/tsc.sh",
     "clean": "rm -rf ./dest .tsbuildinfo ./artifacts",
@@ -73,7 +72,6 @@
   },
   "dependencies": {
     "@aztec/foundation": "workspace:^",
-    "@aztec/protocol-contracts": "workspace:^",
     "@aztec/stdlib": "workspace:^",
     "tslib": "^2.4.0"
   },

yarn-project/standard-contracts/package.json

@@ -0,0 +1,7 @@
+// Address-only leaf export for browser bundles: importing from
+// `@aztec/standard-contracts/auth-registry/address` avoids dragging in the
+// `AuthRegistry.json` static import.
+import { StandardContractAddress, StandardContractClassId } from '../standard_contract_data.js';
+
+export const AUTH_REGISTRY_ADDRESS = StandardContractAddress.AuthRegistry;
+export const AUTH_REGISTRY_CLASS_ID = StandardContractClassId.AuthRegistry;

yarn-project/standard-contracts/src/auth-registry/README.md

@@ -1,50 +1,20 @@
-import { Fr } from '@aztec/foundation/curves/bn254';
-import type { ProtocolContract } from '@aztec/protocol-contracts';
-import { type ContractArtifact, loadContractArtifact } from '@aztec/stdlib/abi';
-import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import { computeInitializationHash, getContractClassFromArtifact } from '@aztec/stdlib/contract';
-import { PublicKeys } from '@aztec/stdlib/keys';
+import { loadContractArtifact } from '@aztec/stdlib/abi';
 import type { NoirCompiledContract } from '@aztec/stdlib/noir';
 
 import AuthRegistryJson from '../../artifacts/AuthRegistry.json' with { type: 'json' };
-import { AUTH_REGISTRY_ADDRESS, AUTH_REGISTRY_CLASS_ID } from './address.gen.js';
+import { makeStandardContract } from '../make_standard_contract.js';
+import type { StandardContract } from '../standard_contract.js';
 
-export { AUTH_REGISTRY_ADDRESS, AUTH_REGISTRY_CLASS_ID } from './address.gen.js';
+export { AUTH_REGISTRY_ADDRESS, AUTH_REGISTRY_CLASS_ID } from './address.js';
 
-let protocolContract: ProtocolContract;
+export const AuthRegistryArtifact = loadContractArtifact(AuthRegistryJson as NoirCompiledContract);
 
-export const AuthRegistryArtifact: ContractArtifact = loadContractArtifact(AuthRegistryJson as NoirCompiledContract);
+let standardContract: StandardContract;
 
 /** Returns the standard deployment of the auth registry. */
-export async function getStandardAuthRegistry(): Promise<ProtocolContract> {
-  if (!protocolContract) {
-    protocolContract = await buildAuthRegistryProtocolContract(AuthRegistryArtifact);
+export function getStandardAuthRegistry(): Promise<StandardContract> {
+  if (!standardContract) {
+    standardContract = makeStandardContract('AuthRegistry', AuthRegistryArtifact);
   }
-  return protocolContract;
-}
-
-async function buildAuthRegistryProtocolContract(artifact: ContractArtifact): Promise<ProtocolContract> {
-  const contractClass = await getContractClassFromArtifact(artifact);
-  if (!contractClass.id.equals(AUTH_REGISTRY_CLASS_ID)) {
-    throw new Error(
-      `auth_registry artifact class id ${contractClass.id.toString()} does not match committed ` +
-        `AUTH_REGISTRY_CLASS_ID ${AUTH_REGISTRY_CLASS_ID.toString()}; regenerate via ` +
-        `\`yarn workspace @aztec/standard-contracts run regen:auth-registry-address\`.`,
-    );
-  }
-  const constructorArtifact = artifact.functions.find(f => f.name === 'constructor');
-  const initializationHash = await computeInitializationHash(constructorArtifact, []);
-
-  const instance = {
-    version: 1 as const,
-    currentContractClassId: AUTH_REGISTRY_CLASS_ID,
-    originalContractClassId: AUTH_REGISTRY_CLASS_ID,
-    initializationHash,
-    publicKeys: PublicKeys.default(),
-    salt: new Fr(1),
-    deployer: AztecAddress.ZERO,
-    address: AUTH_REGISTRY_ADDRESS,
-  };
-
-  return { instance, contractClass, artifact, address: AUTH_REGISTRY_ADDRESS };
+  return Promise.resolve(standardContract);
 }