feat: add key registry to deployment (e2e & sandbox)

noir-projects/noir-protocol-circuits/crates/types/src/constants.nr

@@ -134,6 +134,8 @@ global DEFAULT_TEARDOWN_GAS_LIMIT: u32 = 100_000_000;
 global DEFAULT_MAX_FEE_PER_GAS: Field = 10;
 global DEFAULT_INCLUSION_FEE: Field = 0;
 
+global CANONICAL_KEY_REGISTRY_ADDRESS = 0x0fde809aaeb2210ca367381dfa9a46fb4542d67bcb27538e8de72151ae6d545c;
+
 // LENGTH OF STRUCTS SERIALIZED TO FIELDS
 global AZTEC_ADDRESS_LENGTH = 1;
 global GAS_FEES_LENGTH: u64 = 3;

yarn-project/aztec/src/sandbox.ts

@@ -31,6 +31,7 @@ import {
   RollupBytecode,
 } from '@aztec/l1-artifacts';
 import { getCanonicalGasToken } from '@aztec/protocol-contracts/gas-token';
+import { getCanonicalKeyRegistry } from '@aztec/protocol-contracts/key-registry';
 import { type PXEServiceConfig, createPXEService, getPXEServiceConfig } from '@aztec/pxe';
 
 import {
@@ -182,6 +183,26 @@ async function deployCanonicalL2GasToken(deployer: Wallet, l1ContractAddresses:
   logger.info(`Deployed Gas Token on L2 at ${canonicalGasToken.address}`);
 }
 
+/**
+ * Deploys the key registry on L2.
+ */
+async function deployCanonicalKeyRegistry(deployer: Wallet) {
+  const canonicalKeyRegistry = getCanonicalKeyRegistry();
+
+  if (await deployer.isContractClassPubliclyRegistered(canonicalKeyRegistry.contractClass.id)) {
+    return;
+  }
+
+  await new BatchCall(deployer, [
+    (await registerContractClass(deployer, canonicalKeyRegistry.artifact)).request(),
+    deployInstance(deployer, canonicalKeyRegistry.instance).request(),
+  ])
+    .send()
+    .wait();
+
+  logger.info(`Deployed Key Registry on L2 at ${canonicalKeyRegistry.address}`);
+}
+
 /** Sandbox settings. */
 export type SandboxConfig = AztecNodeConfig & {
   /** Mnemonic used to derive the L1 deployer private key.*/
@@ -210,6 +231,10 @@ export async function createSandbox(config: Partial<SandboxConfig> = {}) {
   const node = await createAztecNode(aztecNodeConfig);
   const pxe = await createAztecPXE(node);
 
+  await deployCanonicalKeyRegistry(
+    new SignerlessWallet(pxe, new DefaultMultiCallEntrypoint(aztecNodeConfig.chainId, aztecNodeConfig.version)),
+  );
+
   if (config.enableGas) {
     await deployCanonicalL2GasToken(
       new SignerlessWallet(pxe, new DefaultMultiCallEntrypoint(aztecNodeConfig.chainId, aztecNodeConfig.version)),

yarn-project/end-to-end/src/benchmarks/bench_process_history.test.ts

@@ -21,7 +21,7 @@ import {
 const BLOCK_SIZE = BENCHMARK_HISTORY_BLOCK_SIZE;
 const CHAIN_LENGTHS = BENCHMARK_HISTORY_CHAIN_LENGTHS;
 const MAX_CHAIN_LENGTH = CHAIN_LENGTHS[CHAIN_LENGTHS.length - 1];
-const SETUP_BLOCK_COUNT = 2; // deploy account + deploy contract
+const SETUP_BLOCK_COUNT = 3; // deploy protocol contracts + deploy account + deploy contract
 
 describe('benchmarks/process_history', () => {
   let context: EndToEndContext;

yarn-project/end-to-end/src/e2e_key_registry.test.ts

@@ -2,6 +2,7 @@ import { type AccountWallet, AztecAddress, Fr, type PXE } from '@aztec/aztec.js'
 import { GeneratorIndex } from '@aztec/circuits.js';
 import { poseidon2Hash } from '@aztec/foundation/crypto';
 import { KeyRegistryContract, TestContract } from '@aztec/noir-contracts.js';
+import { getCanonicalKeyRegistryAddress } from '@aztec/protocol-contracts/key-registry';
 
 import { jest } from '@jest/globals';
 
@@ -22,7 +23,7 @@ describe('SharedMutablePrivateGetter', () => {
   beforeAll(async () => {
     ({ teardown, pxe, wallets } = await setup(2));
     testContract = await TestContract.deploy(wallets[0]).send().deployed();
-    keyRegistry = await KeyRegistryContract.deploy(wallets[0]).send().deployed();
+    keyRegistry = await KeyRegistryContract.at(getCanonicalKeyRegistryAddress(), wallets[0]);
 
     await publicDeployAccounts(wallets[0], wallets.slice(0, 2));
   }, 120_000);

yarn-project/end-to-end/src/e2e_private_voting_contract.test.ts

@@ -20,7 +20,7 @@ describe('e2e_voting_contract', () => {
     votingContract = await EasyPrivateVotingContract.deploy(wallet, owner).send().deployed();
 
     logger.info(`Counter contract deployed at ${votingContract.address}`);
-  }, 25_000);
+  }, 45_000);
 
   afterAll(() => teardown());
 

yarn-project/end-to-end/src/fixtures/utils.ts

@@ -47,6 +47,7 @@ import {
   RollupBytecode,
 } from '@aztec/l1-artifacts';
 import { getCanonicalGasToken, getCanonicalGasTokenAddress } from '@aztec/protocol-contracts/gas-token';
+import { getCanonicalKeyRegistry } from '@aztec/protocol-contracts/key-registry';
 import { PXEService, type PXEServiceConfig, createPXEService, getPXEServiceConfig } from '@aztec/pxe';
 import { type SequencerClient } from '@aztec/sequencer-client';
 
@@ -260,10 +261,14 @@ async function setupWithRemoteEnvironment(
   const cheatCodes = CheatCodes.create(config.rpcUrl, pxeClient!);
   const teardown = () => Promise.resolve();
 
+  const { chainId, protocolVersion } = await pxeClient.getNodeInfo();
+  // this contract might already have been deployed
+  // the following deployin functions are idempotent
+  await deployCanonicalKeyRegistry(
+    new SignerlessWallet(pxeClient, new DefaultMultiCallEntrypoint(chainId, protocolVersion)),
+  );
+
   if (enableGas) {
-    const { chainId, protocolVersion } = await pxeClient.getNodeInfo();
-    // this contract might already have been deployed
-    // the following function is idempotent
     await deployCanonicalGasToken(
       new SignerlessWallet(pxeClient, new DefaultMultiCallEntrypoint(chainId, protocolVersion)),
     );
@@ -397,6 +402,11 @@ export async function setup(
   logger.verbose('Creating a pxe...');
   const { pxe, wallets } = await setupPXEService(numberOfAccounts, aztecNode!, pxeOpts, logger);
 
+  logger.verbose('Deploying key registry...');
+  await deployCanonicalKeyRegistry(
+    new SignerlessWallet(pxe, new DefaultMultiCallEntrypoint(config.chainId, config.version)),
+  );
+
   if (enableGas) {
     logger.verbose('Deploying gas token...');
     await deployCanonicalGasToken(
@@ -587,3 +597,21 @@ export async function deployCanonicalGasToken(deployer: Wallet) {
   await expect(deployer.isContractClassPubliclyRegistered(canonicalGasToken.contractClass.id)).resolves.toBe(true);
   await expect(deployer.getContractInstance(canonicalGasToken.instance.address)).resolves.toBeDefined();
 }
+
+export async function deployCanonicalKeyRegistry(deployer: Wallet) {
+  const canonicalKeyRegistry = getCanonicalKeyRegistry();
+
+  if (await deployer.isContractClassPubliclyRegistered(canonicalKeyRegistry.contractClass.id)) {
+    return;
+  }
+
+  await new BatchCall(deployer, [
+    (await registerContractClass(deployer, canonicalKeyRegistry.artifact)).request(),
+    deployInstance(deployer, canonicalKeyRegistry.instance).request(),
+  ])
+    .send()
+    .wait();
+
+  await expect(deployer.isContractClassPubliclyRegistered(canonicalKeyRegistry.contractClass.id)).resolves.toBe(true);
+  await expect(deployer.getContractInstance(canonicalKeyRegistry.instance.address)).resolves.toBeDefined();
+}

yarn-project/protocol-contracts/scripts/copy-contracts.sh

@@ -6,6 +6,7 @@ contracts=(
   contract_class_registerer_contract-ContractClassRegisterer
   contract_instance_deployer_contract-ContractInstanceDeployer
   gas_token_contract-GasToken
+  key_registry_contract-KeyRegistry
   multi_call_entrypoint_contract-MultiCallEntrypoint
 )
 

yarn-project/protocol-contracts/src/key-registry/artifact.ts

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

yarn-project/protocol-contracts/src/key-registry/index.test.ts

@@ -0,0 +1,11 @@
+import { computeContractAddressFromInstance, getContractClassFromArtifact } from '@aztec/circuits.js';
+
+import { getCanonicalKeyRegistry } from './index.js';
+
+describe('KeyRegistry', () => {
+  it('returns canonical protocol contract', () => {
+    const contract = getCanonicalKeyRegistry();
+    expect(computeContractAddressFromInstance(contract.instance)).toEqual(contract.address);
+    expect(getContractClassFromArtifact(contract.artifact).id).toEqual(contract.contractClass.id);
+  });
+});

yarn-project/protocol-contracts/src/key-registry/index.ts

@@ -0,0 +1,13 @@
+import { type AztecAddress } from '@aztec/circuits.js';
+
+import { type ProtocolContract, getCanonicalProtocolContract } from '../protocol_contract.js';
+import { KeyRegistryArtifact } from './artifact.js';
+
+/** Returns the canonical deployment of the gas token. */
+export function getCanonicalKeyRegistry(): ProtocolContract {
+  return getCanonicalProtocolContract(KeyRegistryArtifact, 1337);
+}
+
+export function getCanonicalKeyRegistryAddress(): AztecAddress {
+  return getCanonicalKeyRegistry().address;
+}

yarn-project/pxe/src/pxe_service/create_pxe_service.ts

@@ -6,6 +6,7 @@ import { initStoreForRollup } from '@aztec/kv-store/utils';
 import { getCanonicalClassRegisterer } from '@aztec/protocol-contracts/class-registerer';
 import { getCanonicalGasToken } from '@aztec/protocol-contracts/gas-token';
 import { getCanonicalInstanceDeployer } from '@aztec/protocol-contracts/instance-deployer';
+import { getCanonicalKeyRegistry } from '@aztec/protocol-contracts/key-registry';
 import { getCanonicalMultiCallEntrypointContract } from '@aztec/protocol-contracts/multi-call-entrypoint';
 
 import { join } from 'path';
@@ -47,6 +48,7 @@ export async function createPXEService(
     getCanonicalInstanceDeployer(),
     getCanonicalMultiCallEntrypointContract(),
     getCanonicalGasToken(l1Contracts.gasPortalAddress),
+    getCanonicalKeyRegistry(),
   ]) {
     await server.registerContract(contract);
   }