@aztec/builder 0.0.0-test.1 → 0.0.1-commit.b655e406

package/dest/contract-interface-gen/typescript.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../src/contract-interface-gen/typescript.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,gBAAgB,EAStB,MAAM,mBAAmB,CAAC;AAyR3B;;;;;GAKG;AACH,wBAAsB,mCAAmC,CAAC,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,EAAE,MAAM,mBA8E7G"}
+{"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../src/contract-interface-gen/typescript.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,gBAAgB,EAWtB,MAAM,mBAAmB,CAAC;AAwQ3B;;;;;GAKG;AACH,wBAAsB,mCAAmC,CAAC,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,EAAE,MAAM,mBAkD7G"}

package/dest/contract-interface-gen/typescript.js

@@ -1,4 +1,4 @@
-import { EventSelector, decodeFunctionSignature, getDefaultInitializer, isAztecAddressStruct, isEthAddressStruct, isFunctionSelectorStruct, isWrappedFieldStruct } from '@aztec/stdlib/abi';
+import { EventSelector, decodeFunctionSignature, getAllFunctionAbis, getDefaultInitializer, isAztecAddressStruct, isBoundedVecStruct, isEthAddressStruct, isFunctionSelectorStruct, isWrappedFieldStruct } from '@aztec/stdlib/abi';
 /**
  * Returns the corresponding typescript type for a given Noir type.
  * @param type - The input Noir type.
@@ -28,9 +28,14 @@ import { EventSelector, decodeFunctionSignature, getDefaultInitializer, isAztecA
             if (isWrappedFieldStruct(type)) {
                 return 'WrappedFieldLike';
             }
+            if (isBoundedVecStruct(type)) {
+                // To make BoundedVec easier to work with, we expect a simple array on the input and then we encode it
+                // as a BoundedVec in the ArgumentsEncoder.
+                return `${abiTypeToTypescript(type.fields[0].type)}`;
+            }
             return `{ ${type.fields.map((f)=>`${f.name}: ${abiTypeToTypescript(f.type)}`).join(', ')} }`;
         default:
-            throw new Error(`Unknown type ${type}`);
+            throw new Error(`Unknown type ${type.kind}`);
     }
 }
 /**
@@ -128,9 +133,9 @@ import { EventSelector, decodeFunctionSignature, getDefaultInitializer, isAztecA
   }`;
 }
 /**
- * Generates a static getter for the contract's artifact.
+ * Generates static getters for the contract's artifact.
  * @param name - Name of the contract used to derive name of the artifact import.
- */ function generateArtifactGetter(name) {
+ */ function generateArtifactGetters(name) {
     const artifactName = `${name}ContractArtifact`;
     return `
   /**
@@ -139,6 +144,13 @@ import { EventSelector, decodeFunctionSignature, getDefaultInitializer, isAztecA
   public static get artifact(): ContractArtifact {
     return ${artifactName};
   }
+
+  /**
+   * Returns this contract's artifact with public bytecode.
+   */
+  public static get artifactForPublic(): ContractArtifact {
+    return loadContractArtifactForPublic(${artifactName}Json as NoirCompiledContract);
+  }
   `;
 }
 /**
@@ -148,7 +160,7 @@ import { EventSelector, decodeFunctionSignature, getDefaultInitializer, isAztecA
  * @returns Code.
  */ function generateAbiStatement(name, artifactImportPath) {
     const stmts = [
-        `import ${name}ContractArtifactJson from '${artifactImportPath}' assert { type: 'json' };`,
+        `import ${name}ContractArtifactJson from '${artifactImportPath}' with { type: 'json' };`,
         `export const ${name}ContractArtifact = loadContractArtifact(${name}ContractArtifactJson as NoirCompiledContract);`
     ];
     return stmts.join('\n');
@@ -172,25 +184,6 @@ import { EventSelector, decodeFunctionSignature, getDefaultInitializer, isAztecA
     }
     `;
 }
-/**
- * Generates a getter for the contract notes
- * @param input - The contract artifact.
- */ function generateNotesGetter(input) {
-    const entries = Object.entries(input.notes);
-    if (entries.length === 0) {
-        return '';
-    }
-    const notesUnionType = entries.map(([name])=>`'${name}'`).join(' | ');
-    const noteMetadata = entries.map(([name, { id }])=>`${name}: {
-          id: new NoteSelector(${id.value}),
-        }`).join(',\n');
-    return `public static get notes(): ContractNotes<${notesUnionType}> {
-    return {
-      ${noteMetadata}
-    } as ContractNotes<${notesUnionType}>;
-  }
-  `;
-}
 // events is of type AbiType
 async function generateEvents(events) {
     if (events === undefined) {
@@ -240,51 +233,25 @@ async function generateEvents(events) {
  * @param artifactImportPath - Optional path to import the artifact (if not set, will be required in the constructor).
  * @returns The corresponding ts code.
  */ export async function generateTypescriptContractInterface(input, artifactImportPath) {
-    const methods = input.functions.filter((f)=>!f.isInternal).sort((a, b)=>a.name.localeCompare(b.name)).map(generateMethod);
+    const methods = getAllFunctionAbis(input).filter((f)=>!f.isInternal).sort((a, b)=>a.name.localeCompare(b.name)).map(generateMethod);
     const deploy = artifactImportPath && generateDeploy(input);
     const ctor = artifactImportPath && generateConstructor(input.name);
     const at = artifactImportPath && generateAt(input.name);
     const artifactStatement = artifactImportPath && generateAbiStatement(input.name, artifactImportPath);
-    const artifactGetter = artifactImportPath && generateArtifactGetter(input.name);
+    const artifactGetter = artifactImportPath && generateArtifactGetters(input.name);
     const storageLayoutGetter = artifactImportPath && generateStorageLayoutGetter(input);
-    const notesGetter = artifactImportPath && generateNotesGetter(input);
     const { eventDefs, events } = await generateEvents(input.outputs.structs?.events);
     return `
 /* Autogenerated file, do not edit! */
 
 /* eslint-disable */
-import {
-  type AbiType,
-  AztecAddress,
-  type AztecAddressLike,
-  CompleteAddress,
-  Contract,
-  type ContractArtifact,
-  ContractBase,
-  ContractFunctionInteraction,
-  type ContractInstanceWithAddress,
-  type ContractMethod,
-  type ContractStorageLayout,
-  type ContractNotes,
-  decodeFromAbi,
-  DeployMethod,
-  EthAddress,
-  type EthAddressLike,
-  EventSelector,
-  type FieldLike,
-  Fr,
-  type FunctionSelectorLike,
-  L1EventPayload,
-  loadContractArtifact,
-  type NoirCompiledContract,
-  NoteSelector,
-  Point,
-  type PublicKey,
-  PublicKeys,
-  type Wallet,
-  type U128Like,
-  type WrappedFieldLike,
-} from '@aztec/aztec.js';
+import { AztecAddress, CompleteAddress } from '@aztec/aztec.js/addresses';
+import { type AbiType, type AztecAddressLike, type ContractArtifact, EventSelector, decodeFromAbi, type EthAddressLike, type FieldLike, type FunctionSelectorLike, loadContractArtifact, loadContractArtifactForPublic, type NoirCompiledContract, type U128Like, type WrappedFieldLike } from '@aztec/aztec.js/abi';
+import { Contract, ContractBase, ContractFunctionInteraction, type ContractInstanceWithAddress, type ContractMethod, type ContractStorageLayout, DeployMethod } from '@aztec/aztec.js/contracts';
+import { EthAddress } from '@aztec/aztec.js/addresses';
+import { Fr, Point } from '@aztec/aztec.js/fields';
+import { type PublicKey, PublicKeys } from '@aztec/aztec.js/keys';
+import type { Wallet } from '@aztec/aztec.js/wallet';
 ${artifactStatement}
 
 ${eventDefs}
@@ -303,8 +270,6 @@ export class ${input.name}Contract extends ContractBase {
 
   ${storageLayoutGetter}
 
-  ${notesGetter}
-
   /** Type-safe wrappers for the public methods exposed by the contract. */
   public declare methods: {
     ${methods.join('\n')}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aztec/builder",
-  "version": "0.0.0-test.1",
+  "version": "0.0.1-commit.b655e406",
   "type": "module",
   "exports": {
     ".": "./dest/index.js",
@@ -21,8 +21,6 @@
     "build:dev": "tsc -b --watch",
     "generate": "tsc -b",
     "clean": "rm -rf ./dest .tsbuildinfo",
-    "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 ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}"
   },
   "inherits": [
@@ -64,20 +62,24 @@
     "testTimeout": 120000,
     "setupFiles": [
       "../../foundation/src/jest/setup.mjs"
+    ],
+    "testEnvironment": "../../foundation/src/jest/env.mjs",
+    "setupFilesAfterEnv": [
+      "../../foundation/src/jest/setupAfterEnv.mjs"
     ]
   },
   "dependencies": {
-    "@aztec/foundation": "0.0.0-test.1",
-    "@aztec/stdlib": "0.0.0-test.1",
+    "@aztec/foundation": "0.0.1-commit.b655e406",
+    "@aztec/stdlib": "0.0.1-commit.b655e406",
     "commander": "^12.1.0"
   },
   "devDependencies": {
-    "@jest/globals": "^29.5.0",
-    "@types/jest": "^29.5.0",
-    "@types/node": "^18.7.23",
-    "jest": "^29.5.0",
+    "@jest/globals": "^30.0.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.15.17",
+    "jest": "^30.0.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.4"
+    "typescript": "^5.3.3"
   },
   "files": [
     "dest",
@@ -86,6 +88,6 @@
   ],
   "types": "./dest/index.d.ts",
   "engines": {
-    "node": ">=18"
+    "node": ">=20.10"
   }
 }

package/src/contract-interface-gen/typescript.ts

@@ -3,10 +3,12 @@ import {
   type ABIVariable,
   type ContractArtifact,
   EventSelector,
-  type FunctionArtifact,
+  type FunctionAbi,
   decodeFunctionSignature,
+  getAllFunctionAbis,
   getDefaultInitializer,
   isAztecAddressStruct,
+  isBoundedVecStruct,
   isEthAddressStruct,
   isFunctionSelectorStruct,
   isWrappedFieldStruct,
@@ -42,9 +44,14 @@ function abiTypeToTypescript(type: ABIParameter['type']): string {
       if (isWrappedFieldStruct(type)) {
         return 'WrappedFieldLike';
       }
+      if (isBoundedVecStruct(type)) {
+        // To make BoundedVec easier to work with, we expect a simple array on the input and then we encode it
+        // as a BoundedVec in the ArgumentsEncoder.
+        return `${abiTypeToTypescript(type.fields[0].type)}`;
+      }
       return `{ ${type.fields.map(f => `${f.name}: ${abiTypeToTypescript(f.type)}`).join(', ')} }`;
     default:
-      throw new Error(`Unknown type ${type}`);
+      throw new Error(`Unknown type ${type.kind}`);
   }
 }
 
@@ -62,7 +69,7 @@ function generateParameter(param: ABIParameter) {
  * @param param - A Noir function.
  * @returns The corresponding ts code.
  */
-function generateMethod(entry: FunctionArtifact) {
+function generateMethod(entry: FunctionAbi) {
   const args = entry.parameters.map(generateParameter).join(', ');
   return `
     /** ${entry.name}(${entry.parameters.map(p => `${p.name}: ${p.type.kind}`).join(', ')}) */
@@ -154,10 +161,10 @@ function generateAt(name: string) {
 }
 
 /**
- * Generates a static getter for the contract's artifact.
+ * Generates static getters for the contract's artifact.
  * @param name - Name of the contract used to derive name of the artifact import.
  */
-function generateArtifactGetter(name: string) {
+function generateArtifactGetters(name: string) {
   const artifactName = `${name}ContractArtifact`;
   return `
   /**
@@ -166,6 +173,13 @@ function generateArtifactGetter(name: string) {
   public static get artifact(): ContractArtifact {
     return ${artifactName};
   }
+
+  /**
+   * Returns this contract's artifact with public bytecode.
+   */
+  public static get artifactForPublic(): ContractArtifact {
+    return loadContractArtifactForPublic(${artifactName}Json as NoirCompiledContract);
+  }
   `;
 }
 
@@ -177,7 +191,7 @@ function generateArtifactGetter(name: string) {
  */
 function generateAbiStatement(name: string, artifactImportPath: string) {
   const stmts = [
-    `import ${name}ContractArtifactJson from '${artifactImportPath}' assert { type: 'json' };`,
+    `import ${name}ContractArtifactJson from '${artifactImportPath}' with { type: 'json' };`,
     `export const ${name}ContractArtifact = loadContractArtifact(${name}ContractArtifactJson as NoirCompiledContract);`,
   ];
   return stmts.join('\n');
@@ -212,35 +226,6 @@ function generateStorageLayoutGetter(input: ContractArtifact) {
     `;
 }
 
-/**
- * Generates a getter for the contract notes
- * @param input - The contract artifact.
- */
-function generateNotesGetter(input: ContractArtifact) {
-  const entries = Object.entries(input.notes);
-
-  if (entries.length === 0) {
-    return '';
-  }
-
-  const notesUnionType = entries.map(([name]) => `'${name}'`).join(' | ');
-  const noteMetadata = entries
-    .map(
-      ([name, { id }]) =>
-        `${name}: {
-          id: new NoteSelector(${id.value}),
-        }`,
-    )
-    .join(',\n');
-
-  return `public static get notes(): ContractNotes<${notesUnionType}> {
-    return {
-      ${noteMetadata}
-    } as ContractNotes<${notesUnionType}>;
-  }
-  `;
-}
-
 // events is of type AbiType
 async function generateEvents(events: any[] | undefined) {
   if (events === undefined) {
@@ -298,7 +283,7 @@ async function generateEvents(events: any[] | undefined) {
  * @returns The corresponding ts code.
  */
 export async function generateTypescriptContractInterface(input: ContractArtifact, artifactImportPath?: string) {
-  const methods = input.functions
+  const methods = getAllFunctionAbis(input)
     .filter(f => !f.isInternal)
     .sort((a, b) => a.name.localeCompare(b.name))
     .map(generateMethod);
@@ -306,47 +291,21 @@ export async function generateTypescriptContractInterface(input: ContractArtifac
   const ctor = artifactImportPath && generateConstructor(input.name);
   const at = artifactImportPath && generateAt(input.name);
   const artifactStatement = artifactImportPath && generateAbiStatement(input.name, artifactImportPath);
-  const artifactGetter = artifactImportPath && generateArtifactGetter(input.name);
+  const artifactGetter = artifactImportPath && generateArtifactGetters(input.name);
   const storageLayoutGetter = artifactImportPath && generateStorageLayoutGetter(input);
-  const notesGetter = artifactImportPath && generateNotesGetter(input);
   const { eventDefs, events } = await generateEvents(input.outputs.structs?.events);
 
   return `
 /* Autogenerated file, do not edit! */
 
 /* eslint-disable */
-import {
-  type AbiType,
-  AztecAddress,
-  type AztecAddressLike,
-  CompleteAddress,
-  Contract,
-  type ContractArtifact,
-  ContractBase,
-  ContractFunctionInteraction,
-  type ContractInstanceWithAddress,
-  type ContractMethod,
-  type ContractStorageLayout,
-  type ContractNotes,
-  decodeFromAbi,
-  DeployMethod,
-  EthAddress,
-  type EthAddressLike,
-  EventSelector,
-  type FieldLike,
-  Fr,
-  type FunctionSelectorLike,
-  L1EventPayload,
-  loadContractArtifact,
-  type NoirCompiledContract,
-  NoteSelector,
-  Point,
-  type PublicKey,
-  PublicKeys,
-  type Wallet,
-  type U128Like,
-  type WrappedFieldLike,
-} from '@aztec/aztec.js';
+import { AztecAddress, CompleteAddress } from '@aztec/aztec.js/addresses';
+import { type AbiType, type AztecAddressLike, type ContractArtifact, EventSelector, decodeFromAbi, type EthAddressLike, type FieldLike, type FunctionSelectorLike, loadContractArtifact, loadContractArtifactForPublic, type NoirCompiledContract, type U128Like, type WrappedFieldLike } from '@aztec/aztec.js/abi';
+import { Contract, ContractBase, ContractFunctionInteraction, type ContractInstanceWithAddress, type ContractMethod, type ContractStorageLayout, DeployMethod } from '@aztec/aztec.js/contracts';
+import { EthAddress } from '@aztec/aztec.js/addresses';
+import { Fr, Point } from '@aztec/aztec.js/fields';
+import { type PublicKey, PublicKeys } from '@aztec/aztec.js/keys';
+import type { Wallet } from '@aztec/aztec.js/wallet';
 ${artifactStatement}
 
 ${eventDefs}
@@ -365,8 +324,6 @@ export class ${input.name}Contract extends ContractBase {
 
   ${storageLayoutGetter}
 
-  ${notesGetter}
-
   /** Type-safe wrappers for the public methods exposed by the contract. */
   public declare methods: {
     ${methods.join('\n')}