@aztec/protocol-contracts 0.23.0 → 0.26.1

package/src/class-registerer/artifact.ts

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

package/src/class-registerer/index.ts

@@ -0,0 +1,17 @@
+import { AztecAddress } from '@aztec/circuits.js';
+
+import { ProtocolContract, getCanonicalProtocolContract } from '../protocol_contract.js';
+import { ContractClassRegistererArtifact } from './artifact.js';
+
+/** Returns the canonical deployment of the class registerer contract. */
+export function getCanonicalClassRegisterer(): ProtocolContract {
+  return getCanonicalProtocolContract(ContractClassRegistererArtifact, 1);
+}
+
+/**
+ * Address of the canonical class registerer.
+ * @remarks This should not change often, hence we hardcode it to save from having to recompute it every time.
+ */
+export const ClassRegistererAddress = AztecAddress.fromString(
+  '0x251ab40f36a148a5ac88fe3c2398ec1968d5676b0066299278610b870d738a9e',
+);

package/src/gas-token/artifact.ts

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

package/src/gas-token/index.ts

@@ -0,0 +1,9 @@
+import { ProtocolContract, getCanonicalProtocolContract } from '../protocol_contract.js';
+import { GasTokenArtifact } from './artifact.js';
+
+/** Returns the canonical deployment of the gas token. */
+export function getCanonicalGasToken(): ProtocolContract {
+  return getCanonicalProtocolContract(GasTokenArtifact, 1);
+}
+
+export const GasTokenAddress = getCanonicalGasToken().address;

package/src/index.ts

@@ -0,0 +1 @@
+export { ProtocolContract } from './protocol_contract.js';

package/src/instance-deployer/artifact.ts

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

package/src/instance-deployer/index.ts

@@ -0,0 +1,11 @@
+import { AztecAddress, DEPLOYER_CONTRACT_ADDRESS } from '@aztec/circuits.js';
+
+import { ProtocolContract, getCanonicalProtocolContract } from '../protocol_contract.js';
+import { ContractInstanceDeployerArtifact } from './artifact.js';
+
+/** Returns the canonical deployment of the instance deployer contract. */
+export function getCanonicalInstanceDeployer(): ProtocolContract {
+  return getCanonicalProtocolContract(ContractInstanceDeployerArtifact, 1);
+}
+
+export const InstanceDeployerAddress = AztecAddress.fromBigInt(DEPLOYER_CONTRACT_ADDRESS);

package/src/protocol_contract.ts

@@ -0,0 +1,33 @@
+import { AztecAddress, getContractClassFromArtifact, getContractInstanceFromDeployParams } from '@aztec/circuits.js';
+import { ContractArtifact } from '@aztec/foundation/abi';
+import { Fr } from '@aztec/foundation/fields';
+import { ContractClassWithId, ContractInstanceWithAddress } from '@aztec/types/contracts';
+
+/** Represents a canonical contract in the protocol. */
+export interface ProtocolContract {
+  /** Canonical deployed instance. */
+  instance: ContractInstanceWithAddress;
+  /** Contract class of this contract. */
+  contractClass: ContractClassWithId;
+  /** Complete contract artifact. */
+  artifact: ContractArtifact;
+  /** Deployment address for the canonical instance.  */
+  address: AztecAddress;
+}
+
+/** Returns the canonical deployment a given artifact. */
+export function getCanonicalProtocolContract(
+  artifact: ContractArtifact,
+  salt: Fr | number | bigint,
+  initArgs: any[] = [],
+): ProtocolContract {
+  // TODO(@spalladino): This computes the contract class from the artifact twice.
+  const contractClass = getContractClassFromArtifact(artifact);
+  const instance = getContractInstanceFromDeployParams(artifact, initArgs, new Fr(salt));
+  return {
+    instance,
+    contractClass,
+    artifact,
+    address: instance.address,
+  };
+}