@aztec/builder 0.46.5 → 0.46.6

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

@@ -1,389 +0,0 @@
-import {
-  type ABIParameter,
-  type ContractArtifact,
-  type FunctionArtifact,
-  getDefaultInitializer,
-  isAztecAddressStruct,
-  isEthAddressStruct,
-  isFunctionSelectorStruct,
-  isWrappedFieldStruct,
-} from '@aztec/foundation/abi';
-
-/**
- * Returns the corresponding typescript type for a given Noir type.
- * @param type - The input Noir type.
- * @returns An equivalent typescript type.
- */
-function abiTypeToTypescript(type: ABIParameter['type']): string {
-  switch (type.kind) {
-    case 'field':
-      return 'FieldLike';
-    case 'boolean':
-      return 'boolean';
-    case 'integer':
-      return '(bigint | number)';
-    case 'string':
-      return 'string';
-    case 'array':
-      return `${abiTypeToTypescript(type.type)}[]`;
-    case 'struct':
-      if (isEthAddressStruct(type)) {
-        return 'EthAddressLike';
-      }
-      if (isAztecAddressStruct(type)) {
-        return 'AztecAddressLike';
-      }
-      if (isFunctionSelectorStruct(type)) {
-        return 'FunctionSelectorLike';
-      }
-      if (isWrappedFieldStruct(type)) {
-        return 'WrappedFieldLike';
-      }
-      return `{ ${type.fields.map(f => `${f.name}: ${abiTypeToTypescript(f.type)}`).join(', ')} }`;
-    default:
-      throw new Error(`Unknown type ${type}`);
-  }
-}
-
-/**
- * Generates the typescript code to represent a Noir parameter.
- * @param param - A Noir parameter with name and type.
- * @returns The corresponding ts code.
- */
-function generateParameter(param: ABIParameter) {
-  return `${param.name}: ${abiTypeToTypescript(param.type)}`;
-}
-
-/**
- * Generates the typescript code to represent a Noir function as a type.
- * @param param - A Noir function.
- * @returns The corresponding ts code.
- */
-function generateMethod(entry: FunctionArtifact) {
-  const args = entry.parameters.map(generateParameter).join(', ');
-  return `
-    /** ${entry.name}(${entry.parameters.map(p => `${p.name}: ${p.type.kind}`).join(', ')}) */
-    ${entry.name}: ((${args}) => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;`;
-}
-
-/**
- * Generates a deploy method for this contract.
- * @param input - Build artifact of the contract.
- * @returns A type-safe deploy method in ts.
- */
-function generateDeploy(input: ContractArtifact) {
-  const ctor = getDefaultInitializer(input);
-  const args = (ctor?.parameters ?? []).map(generateParameter).join(', ');
-  const contractName = `${input.name}Contract`;
-  const artifactName = `${contractName}Artifact`;
-
-  return `
-  /**
-   * Creates a tx to deploy a new instance of this contract.
-   */
-  public static deploy(wallet: Wallet, ${args}) {
-    return new DeployMethod<${contractName}>(Fr.ZERO, wallet, ${artifactName}, ${contractName}.at, Array.from(arguments).slice(1));
-  }
-
-  /**
-   * Creates a tx to deploy a new instance of this contract using the specified public keys hash to derive the address.
-   */
-  public static deployWithPublicKeysHash(publicKeysHash: Fr, wallet: Wallet, ${args}) {
-    return new DeployMethod<${contractName}>(publicKeysHash, wallet, ${artifactName}, ${contractName}.at, Array.from(arguments).slice(2));
-  }
-
-  /**
-   * Creates a tx to deploy a new instance of this contract using the specified constructor method.
-   */
-  public static deployWithOpts<M extends keyof ${contractName}['methods']>(
-    opts: { publicKeysHash?: Fr; method?: M; wallet: Wallet },
-    ...args: Parameters<${contractName}['methods'][M]>
-  ) {
-    return new DeployMethod<${contractName}>(
-      opts.publicKeysHash ?? Fr.ZERO,
-      opts.wallet,
-      ${artifactName},
-      ${contractName}.at,
-      Array.from(arguments).slice(1),
-      opts.method ?? 'constructor',
-    );
-  }
-  `;
-}
-
-/**
- * Generates the constructor by supplying the ABI to the parent class so the user doesn't have to.
- * @param name - Name of the contract to derive the ABI name from.
- * @returns A constructor method.
- * @remarks The constructor is private because we want to force the user to use the create method.
- */
-function generateConstructor(name: string) {
-  return `
-  private constructor(
-    instance: ContractInstanceWithAddress,
-    wallet: Wallet,
-  ) {
-    super(instance, ${name}ContractArtifact, wallet);
-  }
-  `;
-}
-
-/**
- * Generates the at method for this contract.
- * @param name - Name of the contract to derive the ABI name from.
- * @returns An at method.
- * @remarks We don't use constructor directly because of the async `wallet.getContractData` call.
- */
-function generateAt(name: string) {
-  return `
-  /**
-   * Creates a contract instance.
-   * @param address - The deployed contract's address.
-   * @param wallet - The wallet to use when interacting with the contract.
-   * @returns A promise that resolves to a new Contract instance.
-   */
-  public static async at(
-    address: AztecAddress,
-    wallet: Wallet,
-  ) {
-    return Contract.at(address, ${name}Contract.artifact, wallet) as Promise<${name}Contract>;
-  }`;
-}
-
-/**
- * Generates a static getter for the contract's artifact.
- * @param name - Name of the contract used to derive name of the artifact import.
- */
-function generateArtifactGetter(name: string) {
-  const artifactName = `${name}ContractArtifact`;
-  return `
-  /**
-   * Returns this contract's artifact.
-   */
-  public static get artifact(): ContractArtifact {
-    return ${artifactName};
-  }
-  `;
-}
-
-/**
- * Generates statements for importing the artifact from json and re-exporting it.
- * @param name - Name of the contract.
- * @param artifactImportPath - Path to load the ABI from.
- * @returns Code.
- */
-function generateAbiStatement(name: string, artifactImportPath: string) {
-  const stmts = [
-    `import ${name}ContractArtifactJson from '${artifactImportPath}' assert { type: 'json' };`,
-    `export const ${name}ContractArtifact = loadContractArtifact(${name}ContractArtifactJson as NoirCompiledContract);`,
-  ];
-  return stmts.join('\n');
-}
-
-/**
- * Generates a getter for the contract's storage layout.
- * @param input - The contract artifact.
- */
-function generateStorageLayoutGetter(input: ContractArtifact) {
-  const entries = Object.entries(input.storageLayout);
-
-  if (entries.length === 0) {
-    return '';
-  }
-
-  const storageFieldsUnionType = entries.map(([name]) => `'${name}'`).join(' | ');
-  const layout = entries
-    .map(
-      ([name, { slot }]) =>
-        `${name}: {
-      slot: new Fr(${slot.toBigInt()}n),
-    }`,
-    )
-    .join(',\n');
-
-  return `public static get storage(): ContractStorageLayout<${storageFieldsUnionType}> {
-      return {
-        ${layout}
-      } as ContractStorageLayout<${storageFieldsUnionType}>;
-    }
-    `;
-}
-
-/**
- * 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
-function generateEvents(events: any[] | undefined) {
-  if (events === undefined) {
-    return { events: '', eventDefs: '' };
-  }
-
-  const eventsMetadata = events.map(event => {
-    const eventName = event.path.split('::').at(-1);
-
-    const eventDefProps = event.fields.map((field: any) => `${field.name}: Fr`);
-    const eventDef = `
-      export type ${eventName} = {
-        ${eventDefProps.join('\n')}
-      }
-    `;
-
-    const fieldNames = event.fields.map((field: any) => `"${field.name}"`);
-    const eventType = `${eventName}: {decode: (payload: L1EventPayload | undefined) => ${eventName} | undefined, eventSelector: EventSelector, fieldNames: string[] }`;
-
-    const eventImpl = `${eventName}: {
-        decode: this.decodeEvent(${event.fields.length}, EventSelector.fromSignature('${eventName}(${event.fields
-      .map(() => 'Field')
-      .join(',')})'), [${fieldNames}]),
-      eventSelector: EventSelector.fromSignature('${eventName}(${event.fields.map(() => 'Field').join(',')})'),
-      fieldNames: [${fieldNames}],
-      }`;
-
-    return {
-      eventDef,
-      eventType,
-      eventImpl,
-    };
-  });
-
-  return {
-    eventDefs: eventsMetadata.map(({ eventDef }) => eventDef).join('\n'),
-    events: `
-    // Partial application is chosen is to avoid the duplication of so much codegen.
-  private static decodeEvent<T>(fieldsLength: number, eventSelector: EventSelector, fields: string[]): (payload: L1EventPayload | undefined) => T | undefined {
-    return (payload: L1EventPayload | undefined): T | undefined => {
-      if (payload === undefined) {
-        return undefined;
-      }
-      if (!eventSelector.equals(payload.eventTypeId)) {
-        return undefined;
-      }
-      if (payload.event.items.length !== fieldsLength) {
-        throw new Error(
-          'Something is weird here, we have matching EventSelectors, but the actual payload has mismatched length',
-        );
-      }
-
-      return fields.reduce(
-        (acc, curr, i) => ({
-          ...acc,
-          [curr]: payload.event.items[i],
-        }),
-        {} as T,
-      );
-    };
-  }
-
-  public static get events(): { ${eventsMetadata.map(({ eventType }) => eventType).join(', ')} } {
-    return {
-      ${eventsMetadata.map(({ eventImpl }) => eventImpl).join(',\n')}
-    };
-  }
-  `,
-  };
-}
-
-/**
- * Generates the typescript code to represent a contract.
- * @param input - The compiled Noir artifact.
- * @param artifactImportPath - Optional path to import the artifact (if not set, will be required in the constructor).
- * @returns The corresponding ts code.
- */
-export function generateTypescriptContractInterface(input: ContractArtifact, artifactImportPath?: string) {
-  const methods = input.functions.filter(f => !f.isInternal).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 storageLayoutGetter = artifactImportPath && generateStorageLayoutGetter(input);
-  const notesGetter = artifactImportPath && generateNotesGetter(input);
-  const { eventDefs, events } = generateEvents(input.outputs.structs?.events);
-
-  return `
-/* Autogenerated file, do not edit! */
-
-/* eslint-disable */
-import {
-  AztecAddress,
-  AztecAddressLike,
-  CompleteAddress,
-  Contract,
-  ContractArtifact,
-  ContractBase,
-  ContractFunctionInteraction,
-  ContractInstanceWithAddress,
-  ContractMethod,
-  ContractStorageLayout,
-  ContractNotes,
-  DeployMethod,
-  EthAddress,
-  EthAddressLike,
-  EventSelector,
-  FieldLike,
-  Fr,
-  FunctionSelectorLike,
-  L1EventPayload,
-  loadContractArtifact,
-  NoirCompiledContract,
-  NoteSelector,
-  Point,
-  PublicKey,
-  Wallet,
-  WrappedFieldLike,
-} from '@aztec/aztec.js';
-${artifactStatement}
-
-${eventDefs}
-
-/**
- * Type-safe interface for contract ${input.name};
- */
-export class ${input.name}Contract extends ContractBase {
-  ${ctor}
-
-  ${at}
-
-  ${deploy}
-
-  ${artifactGetter}
-
-  ${storageLayoutGetter}
-
-  ${notesGetter}
-
-  /** Type-safe wrappers for the public methods exposed by the contract. */
-  public override methods!: {
-    ${methods.join('\n')}
-  };
-
-  ${events}
-}
-`;
-}

package/src/index.ts

@@ -1 +0,0 @@
-export { generateTypescriptContractInterface } from './contract-interface-gen/typescript.js';

package/src/mocked_keys.ts

@@ -1,2 +0,0 @@
-export const mockVerificationKey =
-  '0000000200000800000000740000000f00000003515f3109623eb3c25aa5b16a1a79fd558bac7a7ce62c4560a8c537c77ce80dd339128d1d37b6582ee9e6df9567efb64313471dfa18f520f9ce53161b50dbf7731bc5f900000003515f322bc4cce83a486a92c92fd59bd84e0f92595baa639fc2ed86b00ffa0dfded2a092a669a3bdb7a273a015eda494457cc7ed5236f26cee330c290d45a33b9daa94800000003515f332729426c008c085a81bd34d8ef12dd31e80130339ef99d50013a89e4558eee6d0fa4ffe2ee7b7b62eb92608b2251ac31396a718f9b34978888789042b790a30100000003515f342be6b6824a913eb7a57b03cb1ee7bfb4de02f2f65fe8a4e97baa7766ddb353a82a8a25c49dc63778cd9fe96173f12a2bc77f3682f4c4448f98f1df82c75234a100000003515f351f85760d6ab567465aadc2f180af9eae3800e6958fec96aef53fd8a7b195d7c000c6267a0dd5cfc22b3fe804f53e266069c0e36f51885baec1e7e67650c62e170000000c515f41524954484d455449430d9d0f8ece2aa12012fa21e6e5c859e97bd5704e5c122064a66051294bc5e04213f61f54a0ebdf6fee4d4a6ecf693478191de0c2899bcd8e86a636c8d3eff43400000003515f43224a99d02c86336737c8dd5b746c40d2be6aead8393889a76a18d664029096e90f7fe81adcc92a74350eada9622ac453f49ebac24a066a1f83b394df54dfa0130000000c515f46495845445f42415345060e8a013ed289c2f9fd7473b04f6594b138ddb4b4cf6b901622a14088f04b8d2c83ff74fce56e3d5573b99c7b26d85d5046ce0c6559506acb7a675e7713eb3a00000007515f4c4f4749430721a91cb8da4b917e054f72147e1760cfe0ef3d45090ac0f4961d84ec1996961a25e787b26bd8b50b1a99450f77a424a83513c2b33af268cd253b0587ff50c700000003515f4d05dbd8623b8652511e1eb38d38887a69eceb082f807514f09e127237c5213b401b9325b48c6c225968002318095f89d0ef9cf629b2b7f0172e03bc39aacf6ed800000007515f52414e474504b57a3805e41df328f5ca9aefa40fad5917391543b7b65c6476e60b8f72e9ad07c92f3b3e11c8feae96dedc4b14a6226ef3201244f37cfc1ee5b96781f48d2b000000075349474d415f3125001d1954a18571eaa007144c5a567bb0d2be4def08a8be918b8c05e3b27d312c59ed41e09e144eab5de77ca89a2fd783be702a47c951d3112e3de02ce6e47c000000075349474d415f3223994e6a23618e60fa01c449a7ab88378709197e186d48d604bfb6931ffb15ad11c5ec7a0700570f80088fd5198ab5d5c227f2ad2a455a6edeec024156bb7beb000000075349474d415f3300cda5845f23468a13275d18bddae27c6bb189cf9aa95b6a03a0cb6688c7e8d829639b45cf8607c525cc400b55ebf90205f2f378626dc3406cc59b2d1b474fba000000075349474d415f342d299e7928496ea2d37f10b43afd6a80c90a33b483090d18069ffa275eedb2fc2f82121e8de43dc036d99b478b6227ceef34248939987a19011f065d8b5cef5c0000000010000000000000000100000002000000030000000400000005000000060000000700000008000000090000000a0000000b0000000c0000000d0000000e0000000f';

package/src/utils.ts

@@ -1,33 +0,0 @@
-import { type ContractArtifact } from '@aztec/foundation/abi';
-
-/**
- * Checks if the given input looks like a valid ContractArtifact. The check is not exhaustive,
- * and it's just meant to differentiate between nargo raw build artifacts and the ones
- * produced by this compiler.
- * @param input - Input object.
- * @returns True if it looks like a ContractArtifact.
- */
-export function isContractArtifact(input: any): input is ContractArtifact {
-  if (typeof input !== 'object') {
-    return false;
-  }
-  const maybeContractArtifact = input as ContractArtifact;
-  if (typeof maybeContractArtifact.name !== 'string') {
-    return false;
-  }
-  if (!Array.isArray(maybeContractArtifact.functions)) {
-    return false;
-  }
-  for (const fn of maybeContractArtifact.functions) {
-    if (typeof fn.name !== 'string') {
-      return false;
-    }
-    if (typeof fn.functionType !== 'string') {
-      return false;
-    }
-    if (typeof fn.isInternal !== 'boolean') {
-      return false;
-    }
-  }
-  return true;
-}