@aztec/protocol-contracts 0.23.0

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

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

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,4 @@
+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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJ0aWZhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xhc3MtcmVnaXN0ZXJlci9hcnRpZmFjdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsb0JBQW9CLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUd4RCxPQUFPLDJCQUEyQixNQUFNLDJDQUEyQyxDQUFDLFNBQVMsSUFBSSxFQUFFLE1BQU0sRUFBRSxDQUFDO0FBRTVHLE1BQU0sQ0FBQyxNQUFNLCtCQUErQixHQUFHLG9CQUFvQixDQUNqRSwyQkFBbUQsQ0FDcEQsQ0FBQyJ9

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

@@ -0,0 +1,10 @@
+import { AztecAddress } from '@aztec/circuits.js';
+import { ProtocolContract } from '../protocol_contract.js';
+/** Returns the canonical deployment of the class registerer contract. */
+export declare function getCanonicalClassRegisterer(): ProtocolContract;
+/**
+ * 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 declare const ClassRegistererAddress: AztecAddress;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/class-registerer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAE,gBAAgB,EAAgC,MAAM,yBAAyB,CAAC;AAGzF,yEAAyE;AACzE,wBAAgB,2BAA2B,IAAI,gBAAgB,CAE9D;AAED;;;GAGG;AACH,eAAO,MAAM,sBAAsB,cAElC,CAAC"}

package/dest/class-registerer/index.js

@@ -0,0 +1,13 @@
+import { AztecAddress } from '@aztec/circuits.js';
+import { getCanonicalProtocolContract } from '../protocol_contract.js';
+import { ContractClassRegistererArtifact } from './artifact.js';
+/** Returns the canonical deployment of the class registerer contract. */
+export function getCanonicalClassRegisterer() {
+    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('0x29c0cd0000951bba8af520ad5513cc53d9f0413c5a24a72a4ba8c17894c0bef9');
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xhc3MtcmVnaXN0ZXJlci9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFFbEQsT0FBTyxFQUFvQiw0QkFBNEIsRUFBRSxNQUFNLHlCQUF5QixDQUFDO0FBQ3pGLE9BQU8sRUFBRSwrQkFBK0IsRUFBRSxNQUFNLGVBQWUsQ0FBQztBQUVoRSx5RUFBeUU7QUFDekUsTUFBTSxVQUFVLDJCQUEyQjtJQUN6QyxPQUFPLDRCQUE0QixDQUFDLCtCQUErQixFQUFFLENBQUMsQ0FBQyxDQUFDO0FBQzFFLENBQUM7QUFFRDs7O0dBR0c7QUFDSCxNQUFNLENBQUMsTUFBTSxzQkFBc0IsR0FBRyxZQUFZLENBQUMsVUFBVSxDQUMzRCxvRUFBb0UsQ0FDckUsQ0FBQyJ9

package/dest/index.d.ts

@@ -0,0 +1,2 @@
+export { ProtocolContract } from './protocol_contract.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC"}

package/dest/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

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

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

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,4 @@
+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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJ0aWZhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5zdGFuY2UtZGVwbG95ZXIvYXJ0aWZhY3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLG9CQUFvQixFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFHeEQsT0FBTyw0QkFBNEIsTUFBTSw0Q0FBNEMsQ0FBQyxTQUFTLElBQUksRUFBRSxNQUFNLEVBQUUsQ0FBQztBQUU5RyxNQUFNLENBQUMsTUFBTSxnQ0FBZ0MsR0FBRyxvQkFBb0IsQ0FDbEUsNEJBQW9ELENBQ3JELENBQUMifQ==

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

@@ -0,0 +1,6 @@
+import { AztecAddress } from '@aztec/circuits.js';
+import { ProtocolContract } from '../protocol_contract.js';
+/** Returns the canonical deployment of the instance deployer contract. */
+export declare function getCanonicalInstanceDeployer(): ProtocolContract;
+export declare const InstanceDeployerAddress: AztecAddress;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/instance-deployer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAE,gBAAgB,EAAgC,MAAM,yBAAyB,CAAC;AAGzF,0EAA0E;AAC1E,wBAAgB,4BAA4B,IAAI,gBAAgB,CAE/D;AAED,eAAO,MAAM,uBAAuB,cAEnC,CAAC"}

package/dest/instance-deployer/index.js

@@ -0,0 +1,9 @@
+import { AztecAddress } from '@aztec/circuits.js';
+import { getCanonicalProtocolContract } from '../protocol_contract.js';
+import { ContractInstanceDeployerArtifact } from './artifact.js';
+/** Returns the canonical deployment of the instance deployer contract. */
+export function getCanonicalInstanceDeployer() {
+    return getCanonicalProtocolContract(ContractInstanceDeployerArtifact, 1);
+}
+export const InstanceDeployerAddress = AztecAddress.fromString('0x1799c61aa10430bf6fec46679c4cb76c3ed12cd8b6e73ed7389d5ae296ad1b97');
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5zdGFuY2UtZGVwbG95ZXIvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBRWxELE9BQU8sRUFBb0IsNEJBQTRCLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQztBQUN6RixPQUFPLEVBQUUsZ0NBQWdDLEVBQUUsTUFBTSxlQUFlLENBQUM7QUFFakUsMEVBQTBFO0FBQzFFLE1BQU0sVUFBVSw0QkFBNEI7SUFDMUMsT0FBTyw0QkFBNEIsQ0FBQyxnQ0FBZ0MsRUFBRSxDQUFDLENBQUMsQ0FBQztBQUMzRSxDQUFDO0FBRUQsTUFBTSxDQUFDLE1BQU0sdUJBQXVCLEdBQUcsWUFBWSxDQUFDLFVBQVUsQ0FDNUQsb0VBQW9FLENBQ3JFLENBQUMifQ==

package/dest/protocol_contract.d.ts

@@ -0,0 +1,18 @@
+import { AztecAddress } from '@aztec/circuits.js';
+import { ContractArtifact } from '@aztec/foundation/abi';
+import { Fr } from '@aztec/foundation/fields';
+import { ContractClassWithId, ContractInstance } from '@aztec/types/contracts';
+/** Represents a canonical contract in the protocol. */
+export interface ProtocolContract {
+    /** Canonical deployed instance. */
+    instance: ContractInstance;
+    /** 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 declare function getCanonicalProtocolContract(artifact: ContractArtifact, salt: Fr | number | bigint, initArgs?: any[]): ProtocolContract;
+//# sourceMappingURL=protocol_contract.d.ts.map

package/dest/protocol_contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol_contract.d.ts","sourceRoot":"","sources":["../src/protocol_contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAqE,MAAM,oBAAoB,CAAC;AACrH,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/E,uDAAuD;AACvD,MAAM,WAAW,gBAAgB;IAC/B,mCAAmC;IACnC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,uCAAuC;IACvC,aAAa,EAAE,mBAAmB,CAAC;IACnC,kCAAkC;IAClC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,sDAAsD;IACtD,OAAO,EAAE,YAAY,CAAC;CACvB;AAED,yDAAyD;AACzD,wBAAgB,4BAA4B,CAC1C,QAAQ,EAAE,gBAAgB,EAC1B,IAAI,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EAC1B,QAAQ,GAAE,GAAG,EAAO,GACnB,gBAAgB,CAUlB"}

package/dest/protocol_contract.js

@@ -0,0 +1,15 @@
+import { getContractClassFromArtifact, getContractInstanceFromDeployParams } from '@aztec/circuits.js';
+import { Fr } from '@aztec/foundation/fields';
+/** Returns the canonical deployment a given artifact. */
+export function getCanonicalProtocolContract(artifact, salt, initArgs = []) {
+    // 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,
+    };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvdG9jb2xfY29udHJhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcHJvdG9jb2xfY29udHJhY3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFnQiw0QkFBNEIsRUFBRSxtQ0FBbUMsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBRXJILE9BQU8sRUFBRSxFQUFFLEVBQUUsTUFBTSwwQkFBMEIsQ0FBQztBQWU5Qyx5REFBeUQ7QUFDekQsTUFBTSxVQUFVLDRCQUE0QixDQUMxQyxRQUEwQixFQUMxQixJQUEwQixFQUMxQixXQUFrQixFQUFFO0lBRXBCLCtFQUErRTtJQUMvRSxNQUFNLGFBQWEsR0FBRyw0QkFBNEIsQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUM3RCxNQUFNLFFBQVEsR0FBRyxtQ0FBbUMsQ0FBQyxRQUFRLEVBQUUsUUFBUSxFQUFFLElBQUksRUFBRSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7SUFDdkYsT0FBTztRQUNMLFFBQVE7UUFDUixhQUFhO1FBQ2IsUUFBUTtRQUNSLE9BQU8sRUFBRSxRQUFRLENBQUMsT0FBTztLQUMxQixDQUFDO0FBQ0osQ0FBQyJ9

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@aztec/protocol-contracts",
+  "homepage": "https://github.com/AztecProtocol/aztec-packages/tree/master/yarn-project/protocol-contracts",
+  "description": "Canonical Noir contracts for the Aztec Network",
+  "version": "0.23.0",
+  "type": "module",
+  "exports": {
+    ".": "./dest/index.js",
+    "./*": "./dest/*/index.js"
+  },
+  "typedocOptions": {
+    "entryPoints": [
+      "./src/index.ts",
+      "./src/class-registerer/index.ts",
+      "./src/instance-deployer/index.ts"
+    ],
+    "name": "Protocol Contracts",
+    "tsconfig": "./tsconfig.json"
+  },
+  "scripts": {
+    "build": "yarn clean && yarn build:copy-contracts && tsc -b",
+    "build:copy-contracts": "./scripts/copy-contracts.sh",
+    "build:dev": "tsc -b --watch",
+    "build:ts": "tsc -b",
+    "clean": "rm -rf ./dest .tsbuildinfo ./src/artifacts",
+    "formatting": "run -T prettier --check ./src && run -T eslint ./src",
+    "formatting:fix": "run -T eslint --fix ./src && run -T prettier -w ./src",
+    "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules $(yarn bin jest) --passWithNoTests"
+  },
+  "inherits": [
+    "../package.common.json",
+    "./package.local.json"
+  ],
+  "jest": {
+    "preset": "ts-jest/presets/default-esm",
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.[cm]?js$": "$1"
+    },
+    "testRegex": "./src/.*\\.test\\.(js|mjs|ts)$",
+    "rootDir": "./src"
+  },
+  "dependencies": {
+    "@aztec/circuits.js": "0.23.0",
+    "@aztec/foundation": "0.23.0",
+    "@aztec/types": "0.23.0",
+    "lodash.omit": "^4.5.0",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@types/jest": "^29.5.0",
+    "@types/lodash.omit": "^4.5.9",
+    "@types/node": "^18.7.23",
+    "jest": "^29.5.0",
+    "jest-mock-extended": "^3.0.3",
+    "ts-jest": "^29.1.0",
+    "ts-loader": "^9.4.4",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "files": [
+    "dest",
+    "src",
+    "!*.test.*"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}