@aztec/builder 0.46.7 → 0.47.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/bin/cli.ts"],"names":[],"mappings":""}
@@ -0,0 +1,19 @@
1
+ #!/usr/bin/env node
2
+ import { createConsoleLogger } from '@aztec/foundation/log';
3
+ import { Command } from 'commander';
4
+ import { injectCommands as injectBuilderCommands } from '../index.js';
5
+ const log = createConsoleLogger('aztec:builder');
6
+ const main = async () => {
7
+ const program = new Command('aztec-builder');
8
+ injectBuilderCommands(program);
9
+ await program.parseAsync(process.argv);
10
+ // I force exit here because spawnSync in npm.ts just blocks the process from exiting. Spent a bit of time debugging
11
+ // it without success and I think it doesn't make sense to invest more time in this.
12
+ process.exit(0);
13
+ };
14
+ main().catch(err => {
15
+ log(`Error running command`);
16
+ log(err);
17
+ process.exit(1);
18
+ });
19
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2Jpbi9jbGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUNBLE9BQU8sRUFBRSxtQkFBbUIsRUFBRSxNQUFNLHVCQUF1QixDQUFDO0FBRTVELE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxXQUFXLENBQUM7QUFFcEMsT0FBTyxFQUFFLGNBQWMsSUFBSSxxQkFBcUIsRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUV0RSxNQUFNLEdBQUcsR0FBRyxtQkFBbUIsQ0FBQyxlQUFlLENBQUMsQ0FBQztBQUVqRCxNQUFNLElBQUksR0FBRyxLQUFLLElBQUksRUFBRTtJQUN0QixNQUFNLE9BQU8sR0FBRyxJQUFJLE9BQU8sQ0FBQyxlQUFlLENBQUMsQ0FBQztJQUU3QyxxQkFBcUIsQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUMvQixNQUFNLE9BQU8sQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ3ZDLG9IQUFvSDtJQUNwSCxvRkFBb0Y7SUFDcEYsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztBQUNsQixDQUFDLENBQUM7QUFFRixJQUFJLEVBQUUsQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLEVBQUU7SUFDakIsR0FBRyxDQUFDLHVCQUF1QixDQUFDLENBQUM7SUFDN0IsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ1QsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztBQUNsQixDQUFDLENBQUMsQ0FBQyJ9
@@ -0,0 +1,9 @@
1
+ /** Generate code options */
2
+ export type GenerateCodeOptions = {
3
+ force?: boolean;
4
+ };
5
+ /**
6
+ * Generates Noir interface or Typescript interface for a folder or single file from a Noir compilation artifact.
7
+ */
8
+ export declare function generateCode(outputPath: string, fileOrDirPath: string, opts?: GenerateCodeOptions): Promise<string[]>;
9
+ //# sourceMappingURL=codegen.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"codegen.d.ts","sourceRoot":"","sources":["../../src/contract-interface-gen/codegen.ts"],"names":[],"mappings":"AAYA,4BAA4B;AAC5B,MAAM,MAAM,mBAAmB,GAAG;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtD;;GAEG;AACH,wBAAsB,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,IAAI,GAAE,mBAAwB,qBAkB3G"}
@@ -0,0 +1,86 @@
1
+ /* eslint-disable no-console */
2
+ import { loadContractArtifact } from '@aztec/types/abi';
3
+ import crypto from 'crypto';
4
+ import { access, mkdir, readFile, readdir, stat, writeFile } from 'fs/promises';
5
+ import path from 'path';
6
+ import { generateTypescriptContractInterface } from './typescript.js';
7
+ const cacheFilePath = './codegenCache.json';
8
+ let cache = {};
9
+ /**
10
+ * Generates Noir interface or Typescript interface for a folder or single file from a Noir compilation artifact.
11
+ */
12
+ export async function generateCode(outputPath, fileOrDirPath, opts = {}) {
13
+ await readCache();
14
+ const results = [];
15
+ const stats = await stat(fileOrDirPath);
16
+ if (stats.isDirectory()) {
17
+ const files = (await readdir(fileOrDirPath, { recursive: true, encoding: 'utf-8' })).filter(file => file.endsWith('.json') && !file.startsWith('debug_'));
18
+ for (const file of files) {
19
+ const fullPath = path.join(fileOrDirPath, file);
20
+ results.push(await generateFromNoirAbi(outputPath, fullPath, opts));
21
+ }
22
+ }
23
+ else if (stats.isFile()) {
24
+ results.push(await generateFromNoirAbi(outputPath, fileOrDirPath, opts));
25
+ }
26
+ await writeCache();
27
+ return results;
28
+ }
29
+ /**
30
+ * Generates Noir interface or Typescript interface for a single file Noir compilation artifact.
31
+ */
32
+ async function generateFromNoirAbi(outputPath, noirAbiPath, opts = {}) {
33
+ const fileName = path.basename(noirAbiPath);
34
+ const currentHash = await generateFileHash(noirAbiPath);
35
+ const cachedInstance = isCacheValid(fileName, currentHash);
36
+ if (cachedInstance && !opts.force) {
37
+ console.log(`${fileName} has not changed. Skipping generation.`);
38
+ return `${outputPath}/${cachedInstance.contractName}.ts`;
39
+ }
40
+ const file = await readFile(noirAbiPath, 'utf8');
41
+ const contract = JSON.parse(file);
42
+ const aztecAbi = loadContractArtifact(contract);
43
+ await mkdir(outputPath, { recursive: true });
44
+ let relativeArtifactPath = path.relative(outputPath, noirAbiPath);
45
+ if (relativeArtifactPath === path.basename(noirAbiPath)) {
46
+ // Prepend ./ for local import if the folder is the same
47
+ relativeArtifactPath = `./${relativeArtifactPath}`;
48
+ }
49
+ const tsWrapper = generateTypescriptContractInterface(aztecAbi, relativeArtifactPath);
50
+ const outputFilePath = `${outputPath}/${aztecAbi.name}.ts`;
51
+ await writeFile(outputFilePath, tsWrapper);
52
+ updateCache(fileName, aztecAbi.name, currentHash);
53
+ return outputFilePath;
54
+ }
55
+ async function generateFileHash(filePath) {
56
+ const fileBuffer = await readFile(filePath);
57
+ const hashSum = crypto.createHash('sha256');
58
+ hashSum.update(fileBuffer);
59
+ const hex = hashSum.digest('hex');
60
+ return hex;
61
+ }
62
+ async function readCache() {
63
+ if (await exists(cacheFilePath)) {
64
+ const cacheRaw = await readFile(cacheFilePath, 'utf8');
65
+ cache = JSON.parse(cacheRaw);
66
+ }
67
+ }
68
+ async function writeCache() {
69
+ await writeFile(cacheFilePath, JSON.stringify(cache, null, 2), 'utf8');
70
+ }
71
+ function isCacheValid(contractName, currentHash) {
72
+ return cache[contractName]?.hash === currentHash && cache[contractName];
73
+ }
74
+ function updateCache(fileName, contractName, hash) {
75
+ cache[fileName] = { contractName, hash };
76
+ }
77
+ async function exists(filePath) {
78
+ try {
79
+ await access(filePath);
80
+ return true;
81
+ }
82
+ catch {
83
+ return false;
84
+ }
85
+ }
86
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29kZWdlbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb250cmFjdC1pbnRlcmZhY2UtZ2VuL2NvZGVnZW4udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsK0JBQStCO0FBQy9CLE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBRXhELE9BQU8sTUFBTSxNQUFNLFFBQVEsQ0FBQztBQUM1QixPQUFPLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxRQUFRLEVBQUUsT0FBTyxFQUFFLElBQUksRUFBRSxTQUFTLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDaEYsT0FBTyxJQUFJLE1BQU0sTUFBTSxDQUFDO0FBRXhCLE9BQU8sRUFBRSxtQ0FBbUMsRUFBRSxNQUFNLGlCQUFpQixDQUFDO0FBRXRFLE1BQU0sYUFBYSxHQUFHLHFCQUFxQixDQUFDO0FBQzVDLElBQUksS0FBSyxHQUEyRCxFQUFFLENBQUM7QUFLdkU7O0dBRUc7QUFDSCxNQUFNLENBQUMsS0FBSyxVQUFVLFlBQVksQ0FBQyxVQUFrQixFQUFFLGFBQXFCLEVBQUUsT0FBNEIsRUFBRTtJQUMxRyxNQUFNLFNBQVMsRUFBRSxDQUFDO0lBQ2xCLE1BQU0sT0FBTyxHQUFHLEVBQUUsQ0FBQztJQUNuQixNQUFNLEtBQUssR0FBRyxNQUFNLElBQUksQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUV4QyxJQUFJLEtBQUssQ0FBQyxXQUFXLEVBQUUsRUFBRSxDQUFDO1FBQ3hCLE1BQU0sS0FBSyxHQUFHLENBQUMsTUFBTSxPQUFPLENBQUMsYUFBYSxFQUFFLEVBQUUsU0FBUyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsT0FBTyxFQUFFLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FDekYsSUFBSSxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FDN0QsQ0FBQztRQUNGLEtBQUssTUFBTSxJQUFJLElBQUksS0FBSyxFQUFFLENBQUM7WUFDekIsTUFBTSxRQUFRLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQyxhQUFhLEVBQUUsSUFBSSxDQUFDLENBQUM7WUFDaEQsT0FBTyxDQUFDLElBQUksQ0FBQyxNQUFNLG1CQUFtQixDQUFDLFVBQVUsRUFBRSxRQUFRLEVBQUUsSUFBSSxDQUFDLENBQUMsQ0FBQztRQUN0RSxDQUFDO0lBQ0gsQ0FBQztTQUFNLElBQUksS0FBSyxDQUFDLE1BQU0sRUFBRSxFQUFFLENBQUM7UUFDMUIsT0FBTyxDQUFDLElBQUksQ0FBQyxNQUFNLG1CQUFtQixDQUFDLFVBQVUsRUFBRSxhQUFhLEVBQUUsSUFBSSxDQUFDLENBQUMsQ0FBQztJQUMzRSxDQUFDO0lBQ0QsTUFBTSxVQUFVLEVBQUUsQ0FBQztJQUNuQixPQUFPLE9BQU8sQ0FBQztBQUNqQixDQUFDO0FBRUQ7O0dBRUc7QUFDSCxLQUFLLFVBQVUsbUJBQW1CLENBQUMsVUFBa0IsRUFBRSxXQUFtQixFQUFFLE9BQTRCLEVBQUU7SUFDeEcsTUFBTSxRQUFRLEdBQUcsSUFBSSxDQUFDLFFBQVEsQ0FBQyxXQUFXLENBQUMsQ0FBQztJQUM1QyxNQUFNLFdBQVcsR0FBRyxNQUFNLGdCQUFnQixDQUFDLFdBQVcsQ0FBQyxDQUFDO0lBQ3hELE1BQU0sY0FBYyxHQUFHLFlBQVksQ0FBQyxRQUFRLEVBQUUsV0FBVyxDQUFDLENBQUM7SUFDM0QsSUFBSSxjQUFjLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDbEMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLFFBQVEsd0NBQXdDLENBQUMsQ0FBQztRQUNqRSxPQUFPLEdBQUcsVUFBVSxJQUFJLGNBQWMsQ0FBQyxZQUFZLEtBQUssQ0FBQztJQUMzRCxDQUFDO0lBRUQsTUFBTSxJQUFJLEdBQUcsTUFBTSxRQUFRLENBQUMsV0FBVyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0lBQ2pELE1BQU0sUUFBUSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDbEMsTUFBTSxRQUFRLEdBQUcsb0JBQW9CLENBQUMsUUFBUSxDQUFDLENBQUM7SUFFaEQsTUFBTSxLQUFLLENBQUMsVUFBVSxFQUFFLEVBQUUsU0FBUyxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7SUFFN0MsSUFBSSxvQkFBb0IsR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFDLFVBQVUsRUFBRSxXQUFXLENBQUMsQ0FBQztJQUNsRSxJQUFJLG9CQUFvQixLQUFLLElBQUksQ0FBQyxRQUFRLENBQUMsV0FBVyxDQUFDLEVBQUUsQ0FBQztRQUN4RCx3REFBd0Q7UUFDeEQsb0JBQW9CLEdBQUcsS0FBSyxvQkFBb0IsRUFBRSxDQUFDO0lBQ3JELENBQUM7SUFFRCxNQUFNLFNBQVMsR0FBRyxtQ0FBbUMsQ0FBQyxRQUFRLEVBQUUsb0JBQW9CLENBQUMsQ0FBQztJQUN0RixNQUFNLGNBQWMsR0FBRyxHQUFHLFVBQVUsSUFBSSxRQUFRLENBQUMsSUFBSSxLQUFLLENBQUM7SUFFM0QsTUFBTSxTQUFTLENBQUMsY0FBYyxFQUFFLFNBQVMsQ0FBQyxDQUFDO0lBRTNDLFdBQVcsQ0FBQyxRQUFRLEVBQUUsUUFBUSxDQUFDLElBQUksRUFBRSxXQUFXLENBQUMsQ0FBQztJQUNsRCxPQUFPLGNBQWMsQ0FBQztBQUN4QixDQUFDO0FBRUQsS0FBSyxVQUFVLGdCQUFnQixDQUFDLFFBQWdCO0lBQzlDLE1BQU0sVUFBVSxHQUFHLE1BQU0sUUFBUSxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQzVDLE1BQU0sT0FBTyxHQUFHLE1BQU0sQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDNUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUMzQixNQUFNLEdBQUcsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQ2xDLE9BQU8sR0FBRyxDQUFDO0FBQ2IsQ0FBQztBQUVELEtBQUssVUFBVSxTQUFTO0lBQ3RCLElBQUksTUFBTSxNQUFNLENBQUMsYUFBYSxDQUFDLEVBQUUsQ0FBQztRQUNoQyxNQUFNLFFBQVEsR0FBRyxNQUFNLFFBQVEsQ0FBQyxhQUFhLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFDdkQsS0FBSyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDL0IsQ0FBQztBQUNILENBQUM7QUFFRCxLQUFLLFVBQVUsVUFBVTtJQUN2QixNQUFNLFNBQVMsQ0FBQyxhQUFhLEVBQUUsSUFBSSxDQUFDLFNBQVMsQ0FBQyxLQUFLLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0FBQ3pFLENBQUM7QUFFRCxTQUFTLFlBQVksQ0FBQyxZQUFvQixFQUFFLFdBQW1CO0lBQzdELE9BQU8sS0FBSyxDQUFDLFlBQVksQ0FBQyxFQUFFLElBQUksS0FBSyxXQUFXLElBQUksS0FBSyxDQUFDLFlBQVksQ0FBQyxDQUFDO0FBQzFFLENBQUM7QUFFRCxTQUFTLFdBQVcsQ0FBQyxRQUFnQixFQUFFLFlBQW9CLEVBQUUsSUFBWTtJQUN2RSxLQUFLLENBQUMsUUFBUSxDQUFDLEdBQUcsRUFBRSxZQUFZLEVBQUUsSUFBSSxFQUFFLENBQUM7QUFDM0MsQ0FBQztBQUVELEtBQUssVUFBVSxNQUFNLENBQUMsUUFBZ0I7SUFDcEMsSUFBSSxDQUFDO1FBQ0gsTUFBTSxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDdkIsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBQUMsTUFBTSxDQUFDO1FBQ1AsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0FBQ0gsQ0FBQyJ9
@@ -0,0 +1,9 @@
1
+ import { type ContractArtifact } from '@aztec/foundation/abi';
2
+ /**
3
+ * Generates the typescript code to represent a contract.
4
+ * @param input - The compiled Noir artifact.
5
+ * @param artifactImportPath - Optional path to import the artifact (if not set, will be required in the constructor).
6
+ * @returns The corresponding ts code.
7
+ */
8
+ export declare function generateTypescriptContractInterface(input: ContractArtifact, artifactImportPath?: string): string;
9
+ //# sourceMappingURL=typescript.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../src/contract-interface-gen/typescript.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,gBAAgB,EAOtB,MAAM,uBAAuB,CAAC;AA8S/B;;;;;GAKG;AACH,wBAAgB,mCAAmC,CAAC,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,EAAE,MAAM,UAuEvG"}
@@ -0,0 +1,349 @@
1
+ import { getDefaultInitializer, isAztecAddressStruct, isEthAddressStruct, isFunctionSelectorStruct, isWrappedFieldStruct, } from '@aztec/foundation/abi';
2
+ /**
3
+ * Returns the corresponding typescript type for a given Noir type.
4
+ * @param type - The input Noir type.
5
+ * @returns An equivalent typescript type.
6
+ */
7
+ function abiTypeToTypescript(type) {
8
+ switch (type.kind) {
9
+ case 'field':
10
+ return 'FieldLike';
11
+ case 'boolean':
12
+ return 'boolean';
13
+ case 'integer':
14
+ return '(bigint | number)';
15
+ case 'string':
16
+ return 'string';
17
+ case 'array':
18
+ return `${abiTypeToTypescript(type.type)}[]`;
19
+ case 'struct':
20
+ if (isEthAddressStruct(type)) {
21
+ return 'EthAddressLike';
22
+ }
23
+ if (isAztecAddressStruct(type)) {
24
+ return 'AztecAddressLike';
25
+ }
26
+ if (isFunctionSelectorStruct(type)) {
27
+ return 'FunctionSelectorLike';
28
+ }
29
+ if (isWrappedFieldStruct(type)) {
30
+ return 'WrappedFieldLike';
31
+ }
32
+ return `{ ${type.fields.map(f => `${f.name}: ${abiTypeToTypescript(f.type)}`).join(', ')} }`;
33
+ default:
34
+ throw new Error(`Unknown type ${type}`);
35
+ }
36
+ }
37
+ /**
38
+ * Generates the typescript code to represent a Noir parameter.
39
+ * @param param - A Noir parameter with name and type.
40
+ * @returns The corresponding ts code.
41
+ */
42
+ function generateParameter(param) {
43
+ return `${param.name}: ${abiTypeToTypescript(param.type)}`;
44
+ }
45
+ /**
46
+ * Generates the typescript code to represent a Noir function as a type.
47
+ * @param param - A Noir function.
48
+ * @returns The corresponding ts code.
49
+ */
50
+ function generateMethod(entry) {
51
+ const args = entry.parameters.map(generateParameter).join(', ');
52
+ return `
53
+ /** ${entry.name}(${entry.parameters.map(p => `${p.name}: ${p.type.kind}`).join(', ')}) */
54
+ ${entry.name}: ((${args}) => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;`;
55
+ }
56
+ /**
57
+ * Generates a deploy method for this contract.
58
+ * @param input - Build artifact of the contract.
59
+ * @returns A type-safe deploy method in ts.
60
+ */
61
+ function generateDeploy(input) {
62
+ const ctor = getDefaultInitializer(input);
63
+ const args = (ctor?.parameters ?? []).map(generateParameter).join(', ');
64
+ const contractName = `${input.name}Contract`;
65
+ const artifactName = `${contractName}Artifact`;
66
+ return `
67
+ /**
68
+ * Creates a tx to deploy a new instance of this contract.
69
+ */
70
+ public static deploy(wallet: Wallet, ${args}) {
71
+ return new DeployMethod<${contractName}>(Fr.ZERO, wallet, ${artifactName}, ${contractName}.at, Array.from(arguments).slice(1));
72
+ }
73
+
74
+ /**
75
+ * Creates a tx to deploy a new instance of this contract using the specified public keys hash to derive the address.
76
+ */
77
+ public static deployWithPublicKeysHash(publicKeysHash: Fr, wallet: Wallet, ${args}) {
78
+ return new DeployMethod<${contractName}>(publicKeysHash, wallet, ${artifactName}, ${contractName}.at, Array.from(arguments).slice(2));
79
+ }
80
+
81
+ /**
82
+ * Creates a tx to deploy a new instance of this contract using the specified constructor method.
83
+ */
84
+ public static deployWithOpts<M extends keyof ${contractName}['methods']>(
85
+ opts: { publicKeysHash?: Fr; method?: M; wallet: Wallet },
86
+ ...args: Parameters<${contractName}['methods'][M]>
87
+ ) {
88
+ return new DeployMethod<${contractName}>(
89
+ opts.publicKeysHash ?? Fr.ZERO,
90
+ opts.wallet,
91
+ ${artifactName},
92
+ ${contractName}.at,
93
+ Array.from(arguments).slice(1),
94
+ opts.method ?? 'constructor',
95
+ );
96
+ }
97
+ `;
98
+ }
99
+ /**
100
+ * Generates the constructor by supplying the ABI to the parent class so the user doesn't have to.
101
+ * @param name - Name of the contract to derive the ABI name from.
102
+ * @returns A constructor method.
103
+ * @remarks The constructor is private because we want to force the user to use the create method.
104
+ */
105
+ function generateConstructor(name) {
106
+ return `
107
+ private constructor(
108
+ instance: ContractInstanceWithAddress,
109
+ wallet: Wallet,
110
+ ) {
111
+ super(instance, ${name}ContractArtifact, wallet);
112
+ }
113
+ `;
114
+ }
115
+ /**
116
+ * Generates the at method for this contract.
117
+ * @param name - Name of the contract to derive the ABI name from.
118
+ * @returns An at method.
119
+ * @remarks We don't use constructor directly because of the async `wallet.getContractData` call.
120
+ */
121
+ function generateAt(name) {
122
+ return `
123
+ /**
124
+ * Creates a contract instance.
125
+ * @param address - The deployed contract's address.
126
+ * @param wallet - The wallet to use when interacting with the contract.
127
+ * @returns A promise that resolves to a new Contract instance.
128
+ */
129
+ public static async at(
130
+ address: AztecAddress,
131
+ wallet: Wallet,
132
+ ) {
133
+ return Contract.at(address, ${name}Contract.artifact, wallet) as Promise<${name}Contract>;
134
+ }`;
135
+ }
136
+ /**
137
+ * Generates a static getter for the contract's artifact.
138
+ * @param name - Name of the contract used to derive name of the artifact import.
139
+ */
140
+ function generateArtifactGetter(name) {
141
+ const artifactName = `${name}ContractArtifact`;
142
+ return `
143
+ /**
144
+ * Returns this contract's artifact.
145
+ */
146
+ public static get artifact(): ContractArtifact {
147
+ return ${artifactName};
148
+ }
149
+ `;
150
+ }
151
+ /**
152
+ * Generates statements for importing the artifact from json and re-exporting it.
153
+ * @param name - Name of the contract.
154
+ * @param artifactImportPath - Path to load the ABI from.
155
+ * @returns Code.
156
+ */
157
+ function generateAbiStatement(name, artifactImportPath) {
158
+ const stmts = [
159
+ `import ${name}ContractArtifactJson from '${artifactImportPath}' assert { type: 'json' };`,
160
+ `export const ${name}ContractArtifact = loadContractArtifact(${name}ContractArtifactJson as NoirCompiledContract);`,
161
+ ];
162
+ return stmts.join('\n');
163
+ }
164
+ /**
165
+ * Generates a getter for the contract's storage layout.
166
+ * @param input - The contract artifact.
167
+ */
168
+ function generateStorageLayoutGetter(input) {
169
+ const entries = Object.entries(input.storageLayout);
170
+ if (entries.length === 0) {
171
+ return '';
172
+ }
173
+ const storageFieldsUnionType = entries.map(([name]) => `'${name}'`).join(' | ');
174
+ const layout = entries
175
+ .map(([name, { slot }]) => `${name}: {
176
+ slot: new Fr(${slot.toBigInt()}n),
177
+ }`)
178
+ .join(',\n');
179
+ return `public static get storage(): ContractStorageLayout<${storageFieldsUnionType}> {
180
+ return {
181
+ ${layout}
182
+ } as ContractStorageLayout<${storageFieldsUnionType}>;
183
+ }
184
+ `;
185
+ }
186
+ /**
187
+ * Generates a getter for the contract notes
188
+ * @param input - The contract artifact.
189
+ */
190
+ function generateNotesGetter(input) {
191
+ const entries = Object.entries(input.notes);
192
+ if (entries.length === 0) {
193
+ return '';
194
+ }
195
+ const notesUnionType = entries.map(([name]) => `'${name}'`).join(' | ');
196
+ const noteMetadata = entries
197
+ .map(([name, { id }]) => `${name}: {
198
+ id: new NoteSelector(${id.value}),
199
+ }`)
200
+ .join(',\n');
201
+ return `public static get notes(): ContractNotes<${notesUnionType}> {
202
+ return {
203
+ ${noteMetadata}
204
+ } as ContractNotes<${notesUnionType}>;
205
+ }
206
+ `;
207
+ }
208
+ // events is of type AbiType
209
+ function generateEvents(events) {
210
+ if (events === undefined) {
211
+ return { events: '', eventDefs: '' };
212
+ }
213
+ const eventsMetadata = events.map(event => {
214
+ const eventName = event.path.split('::').at(-1);
215
+ const eventDefProps = event.fields.map((field) => `${field.name}: Fr`);
216
+ const eventDef = `
217
+ export type ${eventName} = {
218
+ ${eventDefProps.join('\n')}
219
+ }
220
+ `;
221
+ const fieldNames = event.fields.map((field) => `"${field.name}"`);
222
+ const eventType = `${eventName}: {decode: (payload: L1EventPayload | undefined) => ${eventName} | undefined, eventSelector: EventSelector, fieldNames: string[] }`;
223
+ const eventImpl = `${eventName}: {
224
+ decode: this.decodeEvent(${event.fields.length}, EventSelector.fromSignature('${eventName}(${event.fields
225
+ .map(() => 'Field')
226
+ .join(',')})'), [${fieldNames}]),
227
+ eventSelector: EventSelector.fromSignature('${eventName}(${event.fields.map(() => 'Field').join(',')})'),
228
+ fieldNames: [${fieldNames}],
229
+ }`;
230
+ return {
231
+ eventDef,
232
+ eventType,
233
+ eventImpl,
234
+ };
235
+ });
236
+ return {
237
+ eventDefs: eventsMetadata.map(({ eventDef }) => eventDef).join('\n'),
238
+ events: `
239
+ // Partial application is chosen is to avoid the duplication of so much codegen.
240
+ private static decodeEvent<T>(fieldsLength: number, eventSelector: EventSelector, fields: string[]): (payload: L1EventPayload | undefined) => T | undefined {
241
+ return (payload: L1EventPayload | undefined): T | undefined => {
242
+ if (payload === undefined) {
243
+ return undefined;
244
+ }
245
+ if (!eventSelector.equals(payload.eventTypeId)) {
246
+ return undefined;
247
+ }
248
+ if (payload.event.items.length !== fieldsLength) {
249
+ throw new Error(
250
+ 'Something is weird here, we have matching EventSelectors, but the actual payload has mismatched length',
251
+ );
252
+ }
253
+
254
+ return fields.reduce(
255
+ (acc, curr, i) => ({
256
+ ...acc,
257
+ [curr]: payload.event.items[i],
258
+ }),
259
+ {} as T,
260
+ );
261
+ };
262
+ }
263
+
264
+ public static get events(): { ${eventsMetadata.map(({ eventType }) => eventType).join(', ')} } {
265
+ return {
266
+ ${eventsMetadata.map(({ eventImpl }) => eventImpl).join(',\n')}
267
+ };
268
+ }
269
+ `,
270
+ };
271
+ }
272
+ /**
273
+ * Generates the typescript code to represent a contract.
274
+ * @param input - The compiled Noir artifact.
275
+ * @param artifactImportPath - Optional path to import the artifact (if not set, will be required in the constructor).
276
+ * @returns The corresponding ts code.
277
+ */
278
+ export function generateTypescriptContractInterface(input, artifactImportPath) {
279
+ const methods = input.functions.filter(f => !f.isInternal).map(generateMethod);
280
+ const deploy = artifactImportPath && generateDeploy(input);
281
+ const ctor = artifactImportPath && generateConstructor(input.name);
282
+ const at = artifactImportPath && generateAt(input.name);
283
+ const artifactStatement = artifactImportPath && generateAbiStatement(input.name, artifactImportPath);
284
+ const artifactGetter = artifactImportPath && generateArtifactGetter(input.name);
285
+ const storageLayoutGetter = artifactImportPath && generateStorageLayoutGetter(input);
286
+ const notesGetter = artifactImportPath && generateNotesGetter(input);
287
+ const { eventDefs, events } = generateEvents(input.outputs.structs?.events);
288
+ return `
289
+ /* Autogenerated file, do not edit! */
290
+
291
+ /* eslint-disable */
292
+ import {
293
+ AztecAddress,
294
+ AztecAddressLike,
295
+ CompleteAddress,
296
+ Contract,
297
+ ContractArtifact,
298
+ ContractBase,
299
+ ContractFunctionInteraction,
300
+ ContractInstanceWithAddress,
301
+ ContractMethod,
302
+ ContractStorageLayout,
303
+ ContractNotes,
304
+ DeployMethod,
305
+ EthAddress,
306
+ EthAddressLike,
307
+ EventSelector,
308
+ FieldLike,
309
+ Fr,
310
+ FunctionSelectorLike,
311
+ L1EventPayload,
312
+ loadContractArtifact,
313
+ NoirCompiledContract,
314
+ NoteSelector,
315
+ Point,
316
+ PublicKey,
317
+ Wallet,
318
+ WrappedFieldLike,
319
+ } from '@aztec/aztec.js';
320
+ ${artifactStatement}
321
+
322
+ ${eventDefs}
323
+
324
+ /**
325
+ * Type-safe interface for contract ${input.name};
326
+ */
327
+ export class ${input.name}Contract extends ContractBase {
328
+ ${ctor}
329
+
330
+ ${at}
331
+
332
+ ${deploy}
333
+
334
+ ${artifactGetter}
335
+
336
+ ${storageLayoutGetter}
337
+
338
+ ${notesGetter}
339
+
340
+ /** Type-safe wrappers for the public methods exposed by the contract. */
341
+ public override methods!: {
342
+ ${methods.join('\n')}
343
+ };
344
+
345
+ ${events}
346
+ }
347
+ `;
348
+ }
349
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"typescript.js","sourceRoot":"","sources":["../../src/contract-interface-gen/typescript.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,qBAAqB,EACrB,oBAAoB,EACpB,kBAAkB,EAClB,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,uBAAuB,CAAC;AAE/B;;;;GAIG;AACH,SAAS,mBAAmB,CAAC,IAA0B;IACrD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,OAAO;YACV,OAAO,WAAW,CAAC;QACrB,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC;QACnB,KAAK,SAAS;YACZ,OAAO,mBAAmB,CAAC;QAC7B,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC;QAClB,KAAK,OAAO;YACV,OAAO,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAC/C,KAAK,QAAQ;YACX,IAAI,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7B,OAAO,gBAAgB,CAAC;YAC1B,CAAC;YACD,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/B,OAAO,kBAAkB,CAAC;YAC5B,CAAC;YACD,IAAI,wBAAwB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnC,OAAO,sBAAsB,CAAC;YAChC,CAAC;YACD,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/B,OAAO,kBAAkB,CAAC;YAC5B,CAAC;YACD,OAAO,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAC/F;YACE,MAAM,IAAI,KAAK,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,KAAmB;IAC5C,OAAO,GAAG,KAAK,CAAC,IAAI,KAAK,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;AAC7D,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,KAAuB;IAC7C,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChE,OAAO;UACC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;MACnF,KAAK,CAAC,IAAI,OAAO,IAAI,uEAAuE,CAAC;AACnG,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,KAAuB;IAC7C,MAAM,IAAI,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxE,MAAM,YAAY,GAAG,GAAG,KAAK,CAAC,IAAI,UAAU,CAAC;IAC7C,MAAM,YAAY,GAAG,GAAG,YAAY,UAAU,CAAC;IAE/C,OAAO;;;;yCAIgC,IAAI;8BACf,YAAY,sBAAsB,YAAY,KAAK,YAAY;;;;;;+EAMd,IAAI;8BACrD,YAAY,6BAA6B,YAAY,KAAK,YAAY;;;;;;iDAMnD,YAAY;;0BAEnC,YAAY;;8BAER,YAAY;;;QAGlC,YAAY;QACZ,YAAY;;;;;GAKjB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,IAAY;IACvC,OAAO;;;;;sBAKa,IAAI;;GAEvB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO;;;;;;;;;;;kCAWyB,IAAI,yCAAyC,IAAI;IAC/E,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,sBAAsB,CAAC,IAAY;IAC1C,MAAM,YAAY,GAAG,GAAG,IAAI,kBAAkB,CAAC;IAC/C,OAAO;;;;;aAKI,YAAY;;GAEtB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,IAAY,EAAE,kBAA0B;IACpE,MAAM,KAAK,GAAG;QACZ,UAAU,IAAI,8BAA8B,kBAAkB,4BAA4B;QAC1F,gBAAgB,IAAI,2CAA2C,IAAI,gDAAgD;KACpH,CAAC;IACF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;;GAGG;AACH,SAAS,2BAA2B,CAAC,KAAuB;IAC1D,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAEpD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,sBAAsB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChF,MAAM,MAAM,GAAG,OAAO;SACnB,GAAG,CACF,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,CACnB,GAAG,IAAI;qBACM,IAAI,CAAC,QAAQ,EAAE;MAC9B,CACD;SACA,IAAI,CAAC,KAAK,CAAC,CAAC;IAEf,OAAO,sDAAsD,sBAAsB;;UAE3E,MAAM;mCACmB,sBAAsB;;KAEpD,CAAC;AACN,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,KAAuB;IAClD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE5C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxE,MAAM,YAAY,GAAG,OAAO;SACzB,GAAG,CACF,CAAC,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CACjB,GAAG,IAAI;iCACkB,EAAE,CAAC,KAAK;UAC/B,CACL;SACA,IAAI,CAAC,KAAK,CAAC,CAAC;IAEf,OAAO,4CAA4C,cAAc;;QAE3D,YAAY;yBACK,cAAc;;GAEpC,CAAC;AACJ,CAAC;AAED,4BAA4B;AAC5B,SAAS,cAAc,CAAC,MAAyB;IAC/C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IACvC,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QACxC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAEhD,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAU,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC;QAC5E,MAAM,QAAQ,GAAG;oBACD,SAAS;UACnB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;;KAE7B,CAAC;QAEF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAU,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;QACvE,MAAM,SAAS,GAAG,GAAG,SAAS,uDAAuD,SAAS,oEAAoE,CAAC;QAEnK,MAAM,SAAS,GAAG,GAAG,SAAS;mCACC,KAAK,CAAC,MAAM,CAAC,MAAM,kCAAkC,SAAS,IAAI,KAAK,CAAC,MAAM;aAC1G,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC;aAClB,IAAI,CAAC,GAAG,CAAC,SAAS,UAAU;oDACiB,SAAS,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;qBACrF,UAAU;QACvB,CAAC;QAEL,OAAO;YACL,QAAQ;YACR,SAAS;YACT,SAAS;SACV,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,SAAS,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACpE,MAAM,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;kCA0BsB,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;QAErF,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;;;GAGjE;KACA,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mCAAmC,CAAC,KAAuB,EAAE,kBAA2B;IACtG,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC/E,MAAM,MAAM,GAAG,kBAAkB,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC;IAC3D,MAAM,IAAI,GAAG,kBAAkB,IAAI,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACnE,MAAM,EAAE,GAAG,kBAAkB,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACxD,MAAM,iBAAiB,GAAG,kBAAkB,IAAI,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;IACrG,MAAM,cAAc,GAAG,kBAAkB,IAAI,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAChF,MAAM,mBAAmB,GAAG,kBAAkB,IAAI,2BAA2B,CAAC,KAAK,CAAC,CAAC;IACrF,MAAM,WAAW,GAAG,kBAAkB,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACrE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAE5E,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgCP,iBAAiB;;EAEjB,SAAS;;;sCAG2B,KAAK,CAAC,IAAI;;eAEjC,KAAK,CAAC,IAAI;IACrB,IAAI;;IAEJ,EAAE;;IAEF,MAAM;;IAEN,cAAc;;IAEd,mBAAmB;;IAEnB,WAAW;;;;MAIT,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;;;IAGpB,MAAM;;CAET,CAAC;AACF,CAAC"}
@@ -0,0 +1,3 @@
1
+ import { type Command } from 'commander';
2
+ export declare function injectCommands(program: Command): Command;
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAGzC,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,WAY9C"}
package/dest/index.js ADDED
@@ -0,0 +1,15 @@
1
+ import { dirname } from 'path';
2
+ export function injectCommands(program) {
3
+ program
4
+ .command('codegen')
5
+ .argument('<noir-abi-path>', 'Path to the Noir ABI or project dir.')
6
+ .option('-o, --outdir <path>', 'Output folder for the generated code.')
7
+ .option('--force', 'Force code generation even when the contract has not changed.')
8
+ .description('Validates and generates an Aztec Contract ABI from Noir ABI.')
9
+ .action(async (noirAbiPath, { outdir, force }) => {
10
+ const { generateCode } = await import('./contract-interface-gen/codegen.js');
11
+ await generateCode(outdir || dirname(noirAbiPath), noirAbiPath, { force });
12
+ });
13
+ return program;
14
+ }
15
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLE9BQU8sRUFBRSxNQUFNLE1BQU0sQ0FBQztBQUUvQixNQUFNLFVBQVUsY0FBYyxDQUFDLE9BQWdCO0lBQzdDLE9BQU87U0FDSixPQUFPLENBQUMsU0FBUyxDQUFDO1NBQ2xCLFFBQVEsQ0FBQyxpQkFBaUIsRUFBRSxzQ0FBc0MsQ0FBQztTQUNuRSxNQUFNLENBQUMscUJBQXFCLEVBQUUsdUNBQXVDLENBQUM7U0FDdEUsTUFBTSxDQUFDLFNBQVMsRUFBRSwrREFBK0QsQ0FBQztTQUNsRixXQUFXLENBQUMsOERBQThELENBQUM7U0FDM0UsTUFBTSxDQUFDLEtBQUssRUFBRSxXQUFtQixFQUFFLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxFQUFFLEVBQUU7UUFDdkQsTUFBTSxFQUFFLFlBQVksRUFBRSxHQUFHLE1BQU0sTUFBTSxDQUFDLHFDQUFxQyxDQUFDLENBQUM7UUFDN0UsTUFBTSxZQUFZLENBQUMsTUFBTSxJQUFJLE9BQU8sQ0FBQyxXQUFXLENBQUMsRUFBRSxXQUFXLEVBQUUsRUFBRSxLQUFLLEVBQUUsQ0FBQyxDQUFDO0lBQzdFLENBQUMsQ0FBQyxDQUFDO0lBQ0wsT0FBTyxPQUFPLENBQUM7QUFDakIsQ0FBQyJ9
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@aztec/builder",
3
- "version": "0.46.7",
3
+ "version": "0.47.0",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": "./dest/index.js",
7
- "./cli": "./dest/cli/index.js"
7
+ "./cli": "./dest/bin/cli.js"
8
8
  },
9
9
  "typedocOptions": {
10
10
  "entryPoints": [
@@ -14,7 +14,7 @@
14
14
  "tsconfig": "./tsconfig.json"
15
15
  },
16
16
  "bin": {
17
- "aztec-builder": "dest/cli.js"
17
+ "aztec-builder": "dest/bin/cli.js"
18
18
  },
19
19
  "scripts": {
20
20
  "build": "yarn clean && tsc -b",
@@ -65,8 +65,8 @@
65
65
  ]
66
66
  },
67
67
  "dependencies": {
68
- "@aztec/cli": "0.46.7",
69
- "@aztec/foundation": "0.46.7",
68
+ "@aztec/foundation": "0.47.0",
69
+ "@aztec/types": "0.47.0",
70
70
  "commander": "^12.1.0"
71
71
  },
72
72
  "devDependencies": {
@@ -1,15 +1,16 @@
1
1
  #!/usr/bin/env node
2
- import { injectCommands as injectBuilderCommands } from '@aztec/cli/builder';
3
2
  import { createConsoleLogger } from '@aztec/foundation/log';
4
3
 
5
4
  import { Command } from 'commander';
6
5
 
6
+ import { injectCommands as injectBuilderCommands } from '../index.js';
7
+
7
8
  const log = createConsoleLogger('aztec:builder');
8
9
 
9
10
  const main = async () => {
10
11
  const program = new Command('aztec-builder');
11
12
 
12
- injectBuilderCommands(program, log);
13
+ injectBuilderCommands(program);
13
14
  await program.parseAsync(process.argv);
14
15
  // I force exit here because spawnSync in npm.ts just blocks the process from exiting. Spent a bit of time debugging
15
16
  // it without success and I think it doesn't make sense to invest more time in this.
@@ -0,0 +1,106 @@
1
+ /* eslint-disable no-console */
2
+ import { loadContractArtifact } from '@aztec/types/abi';
3
+
4
+ import crypto from 'crypto';
5
+ import { access, mkdir, readFile, readdir, stat, writeFile } from 'fs/promises';
6
+ import path from 'path';
7
+
8
+ import { generateTypescriptContractInterface } from './typescript.js';
9
+
10
+ const cacheFilePath = './codegenCache.json';
11
+ let cache: Record<string, { contractName: string; hash: string }> = {};
12
+
13
+ /** Generate code options */
14
+ export type GenerateCodeOptions = { force?: boolean };
15
+
16
+ /**
17
+ * Generates Noir interface or Typescript interface for a folder or single file from a Noir compilation artifact.
18
+ */
19
+ export async function generateCode(outputPath: string, fileOrDirPath: string, opts: GenerateCodeOptions = {}) {
20
+ await readCache();
21
+ const results = [];
22
+ const stats = await stat(fileOrDirPath);
23
+
24
+ if (stats.isDirectory()) {
25
+ const files = (await readdir(fileOrDirPath, { recursive: true, encoding: 'utf-8' })).filter(
26
+ file => file.endsWith('.json') && !file.startsWith('debug_'),
27
+ );
28
+ for (const file of files) {
29
+ const fullPath = path.join(fileOrDirPath, file);
30
+ results.push(await generateFromNoirAbi(outputPath, fullPath, opts));
31
+ }
32
+ } else if (stats.isFile()) {
33
+ results.push(await generateFromNoirAbi(outputPath, fileOrDirPath, opts));
34
+ }
35
+ await writeCache();
36
+ return results;
37
+ }
38
+
39
+ /**
40
+ * Generates Noir interface or Typescript interface for a single file Noir compilation artifact.
41
+ */
42
+ async function generateFromNoirAbi(outputPath: string, noirAbiPath: string, opts: GenerateCodeOptions = {}) {
43
+ const fileName = path.basename(noirAbiPath);
44
+ const currentHash = await generateFileHash(noirAbiPath);
45
+ const cachedInstance = isCacheValid(fileName, currentHash);
46
+ if (cachedInstance && !opts.force) {
47
+ console.log(`${fileName} has not changed. Skipping generation.`);
48
+ return `${outputPath}/${cachedInstance.contractName}.ts`;
49
+ }
50
+
51
+ const file = await readFile(noirAbiPath, 'utf8');
52
+ const contract = JSON.parse(file);
53
+ const aztecAbi = loadContractArtifact(contract);
54
+
55
+ await mkdir(outputPath, { recursive: true });
56
+
57
+ let relativeArtifactPath = path.relative(outputPath, noirAbiPath);
58
+ if (relativeArtifactPath === path.basename(noirAbiPath)) {
59
+ // Prepend ./ for local import if the folder is the same
60
+ relativeArtifactPath = `./${relativeArtifactPath}`;
61
+ }
62
+
63
+ const tsWrapper = generateTypescriptContractInterface(aztecAbi, relativeArtifactPath);
64
+ const outputFilePath = `${outputPath}/${aztecAbi.name}.ts`;
65
+
66
+ await writeFile(outputFilePath, tsWrapper);
67
+
68
+ updateCache(fileName, aztecAbi.name, currentHash);
69
+ return outputFilePath;
70
+ }
71
+
72
+ async function generateFileHash(filePath: string) {
73
+ const fileBuffer = await readFile(filePath);
74
+ const hashSum = crypto.createHash('sha256');
75
+ hashSum.update(fileBuffer);
76
+ const hex = hashSum.digest('hex');
77
+ return hex;
78
+ }
79
+
80
+ async function readCache() {
81
+ if (await exists(cacheFilePath)) {
82
+ const cacheRaw = await readFile(cacheFilePath, 'utf8');
83
+ cache = JSON.parse(cacheRaw);
84
+ }
85
+ }
86
+
87
+ async function writeCache() {
88
+ await writeFile(cacheFilePath, JSON.stringify(cache, null, 2), 'utf8');
89
+ }
90
+
91
+ function isCacheValid(contractName: string, currentHash: string) {
92
+ return cache[contractName]?.hash === currentHash && cache[contractName];
93
+ }
94
+
95
+ function updateCache(fileName: string, contractName: string, hash: string): void {
96
+ cache[fileName] = { contractName, hash };
97
+ }
98
+
99
+ async function exists(filePath: string) {
100
+ try {
101
+ await access(filePath);
102
+ return true;
103
+ } catch {
104
+ return false;
105
+ }
106
+ }
@@ -0,0 +1,389 @@
1
+ import {
2
+ type ABIParameter,
3
+ type ContractArtifact,
4
+ type FunctionArtifact,
5
+ getDefaultInitializer,
6
+ isAztecAddressStruct,
7
+ isEthAddressStruct,
8
+ isFunctionSelectorStruct,
9
+ isWrappedFieldStruct,
10
+ } from '@aztec/foundation/abi';
11
+
12
+ /**
13
+ * Returns the corresponding typescript type for a given Noir type.
14
+ * @param type - The input Noir type.
15
+ * @returns An equivalent typescript type.
16
+ */
17
+ function abiTypeToTypescript(type: ABIParameter['type']): string {
18
+ switch (type.kind) {
19
+ case 'field':
20
+ return 'FieldLike';
21
+ case 'boolean':
22
+ return 'boolean';
23
+ case 'integer':
24
+ return '(bigint | number)';
25
+ case 'string':
26
+ return 'string';
27
+ case 'array':
28
+ return `${abiTypeToTypescript(type.type)}[]`;
29
+ case 'struct':
30
+ if (isEthAddressStruct(type)) {
31
+ return 'EthAddressLike';
32
+ }
33
+ if (isAztecAddressStruct(type)) {
34
+ return 'AztecAddressLike';
35
+ }
36
+ if (isFunctionSelectorStruct(type)) {
37
+ return 'FunctionSelectorLike';
38
+ }
39
+ if (isWrappedFieldStruct(type)) {
40
+ return 'WrappedFieldLike';
41
+ }
42
+ return `{ ${type.fields.map(f => `${f.name}: ${abiTypeToTypescript(f.type)}`).join(', ')} }`;
43
+ default:
44
+ throw new Error(`Unknown type ${type}`);
45
+ }
46
+ }
47
+
48
+ /**
49
+ * Generates the typescript code to represent a Noir parameter.
50
+ * @param param - A Noir parameter with name and type.
51
+ * @returns The corresponding ts code.
52
+ */
53
+ function generateParameter(param: ABIParameter) {
54
+ return `${param.name}: ${abiTypeToTypescript(param.type)}`;
55
+ }
56
+
57
+ /**
58
+ * Generates the typescript code to represent a Noir function as a type.
59
+ * @param param - A Noir function.
60
+ * @returns The corresponding ts code.
61
+ */
62
+ function generateMethod(entry: FunctionArtifact) {
63
+ const args = entry.parameters.map(generateParameter).join(', ');
64
+ return `
65
+ /** ${entry.name}(${entry.parameters.map(p => `${p.name}: ${p.type.kind}`).join(', ')}) */
66
+ ${entry.name}: ((${args}) => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;`;
67
+ }
68
+
69
+ /**
70
+ * Generates a deploy method for this contract.
71
+ * @param input - Build artifact of the contract.
72
+ * @returns A type-safe deploy method in ts.
73
+ */
74
+ function generateDeploy(input: ContractArtifact) {
75
+ const ctor = getDefaultInitializer(input);
76
+ const args = (ctor?.parameters ?? []).map(generateParameter).join(', ');
77
+ const contractName = `${input.name}Contract`;
78
+ const artifactName = `${contractName}Artifact`;
79
+
80
+ return `
81
+ /**
82
+ * Creates a tx to deploy a new instance of this contract.
83
+ */
84
+ public static deploy(wallet: Wallet, ${args}) {
85
+ return new DeployMethod<${contractName}>(Fr.ZERO, wallet, ${artifactName}, ${contractName}.at, Array.from(arguments).slice(1));
86
+ }
87
+
88
+ /**
89
+ * Creates a tx to deploy a new instance of this contract using the specified public keys hash to derive the address.
90
+ */
91
+ public static deployWithPublicKeysHash(publicKeysHash: Fr, wallet: Wallet, ${args}) {
92
+ return new DeployMethod<${contractName}>(publicKeysHash, wallet, ${artifactName}, ${contractName}.at, Array.from(arguments).slice(2));
93
+ }
94
+
95
+ /**
96
+ * Creates a tx to deploy a new instance of this contract using the specified constructor method.
97
+ */
98
+ public static deployWithOpts<M extends keyof ${contractName}['methods']>(
99
+ opts: { publicKeysHash?: Fr; method?: M; wallet: Wallet },
100
+ ...args: Parameters<${contractName}['methods'][M]>
101
+ ) {
102
+ return new DeployMethod<${contractName}>(
103
+ opts.publicKeysHash ?? Fr.ZERO,
104
+ opts.wallet,
105
+ ${artifactName},
106
+ ${contractName}.at,
107
+ Array.from(arguments).slice(1),
108
+ opts.method ?? 'constructor',
109
+ );
110
+ }
111
+ `;
112
+ }
113
+
114
+ /**
115
+ * Generates the constructor by supplying the ABI to the parent class so the user doesn't have to.
116
+ * @param name - Name of the contract to derive the ABI name from.
117
+ * @returns A constructor method.
118
+ * @remarks The constructor is private because we want to force the user to use the create method.
119
+ */
120
+ function generateConstructor(name: string) {
121
+ return `
122
+ private constructor(
123
+ instance: ContractInstanceWithAddress,
124
+ wallet: Wallet,
125
+ ) {
126
+ super(instance, ${name}ContractArtifact, wallet);
127
+ }
128
+ `;
129
+ }
130
+
131
+ /**
132
+ * Generates the at method for this contract.
133
+ * @param name - Name of the contract to derive the ABI name from.
134
+ * @returns An at method.
135
+ * @remarks We don't use constructor directly because of the async `wallet.getContractData` call.
136
+ */
137
+ function generateAt(name: string) {
138
+ return `
139
+ /**
140
+ * Creates a contract instance.
141
+ * @param address - The deployed contract's address.
142
+ * @param wallet - The wallet to use when interacting with the contract.
143
+ * @returns A promise that resolves to a new Contract instance.
144
+ */
145
+ public static async at(
146
+ address: AztecAddress,
147
+ wallet: Wallet,
148
+ ) {
149
+ return Contract.at(address, ${name}Contract.artifact, wallet) as Promise<${name}Contract>;
150
+ }`;
151
+ }
152
+
153
+ /**
154
+ * Generates a static getter for the contract's artifact.
155
+ * @param name - Name of the contract used to derive name of the artifact import.
156
+ */
157
+ function generateArtifactGetter(name: string) {
158
+ const artifactName = `${name}ContractArtifact`;
159
+ return `
160
+ /**
161
+ * Returns this contract's artifact.
162
+ */
163
+ public static get artifact(): ContractArtifact {
164
+ return ${artifactName};
165
+ }
166
+ `;
167
+ }
168
+
169
+ /**
170
+ * Generates statements for importing the artifact from json and re-exporting it.
171
+ * @param name - Name of the contract.
172
+ * @param artifactImportPath - Path to load the ABI from.
173
+ * @returns Code.
174
+ */
175
+ function generateAbiStatement(name: string, artifactImportPath: string) {
176
+ const stmts = [
177
+ `import ${name}ContractArtifactJson from '${artifactImportPath}' assert { type: 'json' };`,
178
+ `export const ${name}ContractArtifact = loadContractArtifact(${name}ContractArtifactJson as NoirCompiledContract);`,
179
+ ];
180
+ return stmts.join('\n');
181
+ }
182
+
183
+ /**
184
+ * Generates a getter for the contract's storage layout.
185
+ * @param input - The contract artifact.
186
+ */
187
+ function generateStorageLayoutGetter(input: ContractArtifact) {
188
+ const entries = Object.entries(input.storageLayout);
189
+
190
+ if (entries.length === 0) {
191
+ return '';
192
+ }
193
+
194
+ const storageFieldsUnionType = entries.map(([name]) => `'${name}'`).join(' | ');
195
+ const layout = entries
196
+ .map(
197
+ ([name, { slot }]) =>
198
+ `${name}: {
199
+ slot: new Fr(${slot.toBigInt()}n),
200
+ }`,
201
+ )
202
+ .join(',\n');
203
+
204
+ return `public static get storage(): ContractStorageLayout<${storageFieldsUnionType}> {
205
+ return {
206
+ ${layout}
207
+ } as ContractStorageLayout<${storageFieldsUnionType}>;
208
+ }
209
+ `;
210
+ }
211
+
212
+ /**
213
+ * Generates a getter for the contract notes
214
+ * @param input - The contract artifact.
215
+ */
216
+ function generateNotesGetter(input: ContractArtifact) {
217
+ const entries = Object.entries(input.notes);
218
+
219
+ if (entries.length === 0) {
220
+ return '';
221
+ }
222
+
223
+ const notesUnionType = entries.map(([name]) => `'${name}'`).join(' | ');
224
+ const noteMetadata = entries
225
+ .map(
226
+ ([name, { id }]) =>
227
+ `${name}: {
228
+ id: new NoteSelector(${id.value}),
229
+ }`,
230
+ )
231
+ .join(',\n');
232
+
233
+ return `public static get notes(): ContractNotes<${notesUnionType}> {
234
+ return {
235
+ ${noteMetadata}
236
+ } as ContractNotes<${notesUnionType}>;
237
+ }
238
+ `;
239
+ }
240
+
241
+ // events is of type AbiType
242
+ function generateEvents(events: any[] | undefined) {
243
+ if (events === undefined) {
244
+ return { events: '', eventDefs: '' };
245
+ }
246
+
247
+ const eventsMetadata = events.map(event => {
248
+ const eventName = event.path.split('::').at(-1);
249
+
250
+ const eventDefProps = event.fields.map((field: any) => `${field.name}: Fr`);
251
+ const eventDef = `
252
+ export type ${eventName} = {
253
+ ${eventDefProps.join('\n')}
254
+ }
255
+ `;
256
+
257
+ const fieldNames = event.fields.map((field: any) => `"${field.name}"`);
258
+ const eventType = `${eventName}: {decode: (payload: L1EventPayload | undefined) => ${eventName} | undefined, eventSelector: EventSelector, fieldNames: string[] }`;
259
+
260
+ const eventImpl = `${eventName}: {
261
+ decode: this.decodeEvent(${event.fields.length}, EventSelector.fromSignature('${eventName}(${event.fields
262
+ .map(() => 'Field')
263
+ .join(',')})'), [${fieldNames}]),
264
+ eventSelector: EventSelector.fromSignature('${eventName}(${event.fields.map(() => 'Field').join(',')})'),
265
+ fieldNames: [${fieldNames}],
266
+ }`;
267
+
268
+ return {
269
+ eventDef,
270
+ eventType,
271
+ eventImpl,
272
+ };
273
+ });
274
+
275
+ return {
276
+ eventDefs: eventsMetadata.map(({ eventDef }) => eventDef).join('\n'),
277
+ events: `
278
+ // Partial application is chosen is to avoid the duplication of so much codegen.
279
+ private static decodeEvent<T>(fieldsLength: number, eventSelector: EventSelector, fields: string[]): (payload: L1EventPayload | undefined) => T | undefined {
280
+ return (payload: L1EventPayload | undefined): T | undefined => {
281
+ if (payload === undefined) {
282
+ return undefined;
283
+ }
284
+ if (!eventSelector.equals(payload.eventTypeId)) {
285
+ return undefined;
286
+ }
287
+ if (payload.event.items.length !== fieldsLength) {
288
+ throw new Error(
289
+ 'Something is weird here, we have matching EventSelectors, but the actual payload has mismatched length',
290
+ );
291
+ }
292
+
293
+ return fields.reduce(
294
+ (acc, curr, i) => ({
295
+ ...acc,
296
+ [curr]: payload.event.items[i],
297
+ }),
298
+ {} as T,
299
+ );
300
+ };
301
+ }
302
+
303
+ public static get events(): { ${eventsMetadata.map(({ eventType }) => eventType).join(', ')} } {
304
+ return {
305
+ ${eventsMetadata.map(({ eventImpl }) => eventImpl).join(',\n')}
306
+ };
307
+ }
308
+ `,
309
+ };
310
+ }
311
+
312
+ /**
313
+ * Generates the typescript code to represent a contract.
314
+ * @param input - The compiled Noir artifact.
315
+ * @param artifactImportPath - Optional path to import the artifact (if not set, will be required in the constructor).
316
+ * @returns The corresponding ts code.
317
+ */
318
+ export function generateTypescriptContractInterface(input: ContractArtifact, artifactImportPath?: string) {
319
+ const methods = input.functions.filter(f => !f.isInternal).map(generateMethod);
320
+ const deploy = artifactImportPath && generateDeploy(input);
321
+ const ctor = artifactImportPath && generateConstructor(input.name);
322
+ const at = artifactImportPath && generateAt(input.name);
323
+ const artifactStatement = artifactImportPath && generateAbiStatement(input.name, artifactImportPath);
324
+ const artifactGetter = artifactImportPath && generateArtifactGetter(input.name);
325
+ const storageLayoutGetter = artifactImportPath && generateStorageLayoutGetter(input);
326
+ const notesGetter = artifactImportPath && generateNotesGetter(input);
327
+ const { eventDefs, events } = generateEvents(input.outputs.structs?.events);
328
+
329
+ return `
330
+ /* Autogenerated file, do not edit! */
331
+
332
+ /* eslint-disable */
333
+ import {
334
+ AztecAddress,
335
+ AztecAddressLike,
336
+ CompleteAddress,
337
+ Contract,
338
+ ContractArtifact,
339
+ ContractBase,
340
+ ContractFunctionInteraction,
341
+ ContractInstanceWithAddress,
342
+ ContractMethod,
343
+ ContractStorageLayout,
344
+ ContractNotes,
345
+ DeployMethod,
346
+ EthAddress,
347
+ EthAddressLike,
348
+ EventSelector,
349
+ FieldLike,
350
+ Fr,
351
+ FunctionSelectorLike,
352
+ L1EventPayload,
353
+ loadContractArtifact,
354
+ NoirCompiledContract,
355
+ NoteSelector,
356
+ Point,
357
+ PublicKey,
358
+ Wallet,
359
+ WrappedFieldLike,
360
+ } from '@aztec/aztec.js';
361
+ ${artifactStatement}
362
+
363
+ ${eventDefs}
364
+
365
+ /**
366
+ * Type-safe interface for contract ${input.name};
367
+ */
368
+ export class ${input.name}Contract extends ContractBase {
369
+ ${ctor}
370
+
371
+ ${at}
372
+
373
+ ${deploy}
374
+
375
+ ${artifactGetter}
376
+
377
+ ${storageLayoutGetter}
378
+
379
+ ${notesGetter}
380
+
381
+ /** Type-safe wrappers for the public methods exposed by the contract. */
382
+ public override methods!: {
383
+ ${methods.join('\n')}
384
+ };
385
+
386
+ ${events}
387
+ }
388
+ `;
389
+ }
package/src/index.ts ADDED
@@ -0,0 +1,16 @@
1
+ import { type Command } from 'commander';
2
+ import { dirname } from 'path';
3
+
4
+ export function injectCommands(program: Command) {
5
+ program
6
+ .command('codegen')
7
+ .argument('<noir-abi-path>', 'Path to the Noir ABI or project dir.')
8
+ .option('-o, --outdir <path>', 'Output folder for the generated code.')
9
+ .option('--force', 'Force code generation even when the contract has not changed.')
10
+ .description('Validates and generates an Aztec Contract ABI from Noir ABI.')
11
+ .action(async (noirAbiPath: string, { outdir, force }) => {
12
+ const { generateCode } = await import('./contract-interface-gen/codegen.js');
13
+ await generateCode(outdir || dirname(noirAbiPath), noirAbiPath, { force });
14
+ });
15
+ return program;
16
+ }
package/dest/cli.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}
package/dest/cli.js DELETED
@@ -1,19 +0,0 @@
1
- #!/usr/bin/env node
2
- import { injectCommands as injectBuilderCommands } from '@aztec/cli/builder';
3
- import { createConsoleLogger } from '@aztec/foundation/log';
4
- import { Command } from 'commander';
5
- const log = createConsoleLogger('aztec:builder');
6
- const main = async () => {
7
- const program = new Command('aztec-builder');
8
- injectBuilderCommands(program, log);
9
- await program.parseAsync(process.argv);
10
- // I force exit here because spawnSync in npm.ts just blocks the process from exiting. Spent a bit of time debugging
11
- // it without success and I think it doesn't make sense to invest more time in this.
12
- process.exit(0);
13
- };
14
- main().catch(err => {
15
- log(`Error running command`);
16
- log(err);
17
- process.exit(1);
18
- });
19
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NsaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQ0EsT0FBTyxFQUFFLGNBQWMsSUFBSSxxQkFBcUIsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBQzdFLE9BQU8sRUFBRSxtQkFBbUIsRUFBRSxNQUFNLHVCQUF1QixDQUFDO0FBRTVELE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxXQUFXLENBQUM7QUFFcEMsTUFBTSxHQUFHLEdBQUcsbUJBQW1CLENBQUMsZUFBZSxDQUFDLENBQUM7QUFFakQsTUFBTSxJQUFJLEdBQUcsS0FBSyxJQUFJLEVBQUU7SUFDdEIsTUFBTSxPQUFPLEdBQUcsSUFBSSxPQUFPLENBQUMsZUFBZSxDQUFDLENBQUM7SUFFN0MscUJBQXFCLENBQUMsT0FBTyxFQUFFLEdBQUcsQ0FBQyxDQUFDO0lBQ3BDLE1BQU0sT0FBTyxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDdkMsb0hBQW9IO0lBQ3BILG9GQUFvRjtJQUNwRixPQUFPLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO0FBQ2xCLENBQUMsQ0FBQztBQUVGLElBQUksRUFBRSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsRUFBRTtJQUNqQixHQUFHLENBQUMsdUJBQXVCLENBQUMsQ0FBQztJQUM3QixHQUFHLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDVCxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO0FBQ2xCLENBQUMsQ0FBQyxDQUFDIn0=
File without changes