@aztec/pxe 0.11.1 → 0.13.0

package/src/pxe_http/pxe_http_server.ts

@@ -7,12 +7,13 @@ import {
   CompleteAddress,
   ContractData,
   ExtendedContractData,
+  ExtendedNote,
   ExtendedUnencryptedL2Log,
   L2Block,
   L2BlockL2Logs,
   L2Tx,
   LogId,
-  NotePreimage,
+  Note,
   PXE,
   Tx,
   TxExecutionRequest,
@@ -47,7 +48,8 @@ export function createPXERpcServer(pxeService: PXE): JsonRpcServer {
       Point,
       Fr,
       GrumpkinScalar,
-      NotePreimage,
+      Note,
+      ExtendedNote,
       AuthWitness,
       L2Block,
       L2Tx,

package/src/pxe_service/pxe_service.ts

@@ -22,7 +22,7 @@ import { encodeArguments } from '@aztec/foundation/abi';
 import { padArrayEnd } from '@aztec/foundation/collection';
 import { Fr } from '@aztec/foundation/fields';
 import { DebugLogger, createDebugLogger } from '@aztec/foundation/log';
-import NoirVersion from '@aztec/noir-compiler/noir-version';
+import { NoirVersion } from '@aztec/noir-compiler/noir-version';
 import {
   AuthWitness,
   AztecNode,
@@ -30,6 +30,7 @@ import {
   ContractData,
   DeployedContract,
   ExtendedContractData,
+  ExtendedNote,
   FunctionCall,
   GetUnencryptedLogsResponse,
   KeyStore,
@@ -38,7 +39,7 @@ import {
   LogFilter,
   MerkleTreeId,
   NodeInfo,
-  NotePreimage,
+  NoteFilter,
   PXE,
   SimulationError,
   Tx,
@@ -55,6 +56,7 @@ import {
 import { PXEServiceConfig, getPackageInfo } from '../config/index.js';
 import { ContractDataOracle } from '../contract_data_oracle/index.js';
 import { Database } from '../database/index.js';
+import { NoteDao } from '../database/note_dao.js';
 import { KernelOracle } from '../kernel_oracle/index.js';
 import { KernelProver } from '../kernel_prover/kernel_prover.js';
 import { getAcirSimulator } from '../simulator/index.js';
@@ -192,40 +194,40 @@ export class PXEService implements PXE {
     return await this.node.getPublicStorageAt(contract, storageSlot.value);
   }
 
-  public async getPrivateStorageAt(owner: AztecAddress, contract: AztecAddress, storageSlot: Fr) {
-    if ((await this.getContractData(contract)) === undefined) {
-      throw new Error(`Contract ${contract.toString()} is not deployed`);
-    }
-    const notes = await this.db.getNoteSpendingInfo(contract, storageSlot);
-    const ownerCompleteAddress = await this.db.getCompleteAddress(owner);
-    if (!ownerCompleteAddress) throw new Error(`Owner ${owner} not registered in PXE`);
-    const { publicKey: ownerPublicKey } = ownerCompleteAddress;
-    const ownerNotes = notes.filter(n => n.publicKey.equals(ownerPublicKey));
-    return ownerNotes.map(n => n.notePreimage);
-  }
-
-  public async addNote(
-    account: AztecAddress,
-    contractAddress: AztecAddress,
-    storageSlot: Fr,
-    preimage: NotePreimage,
-    txHash: TxHash,
-    nonce?: Fr,
-  ) {
-    const { publicKey } = (await this.db.getCompleteAddress(account)) ?? {};
+  public async getNotes(filter: NoteFilter): Promise<ExtendedNote[]> {
+    const noteDaos = await this.db.getNotes(filter);
+
+    // TODO(benesjan): Refactor --> This type conversion is ugly but I decided to keep it this way for now because
+    // key derivation will affect all this
+    const extendedNotes = noteDaos.map(async dao => {
+      let owner = filter.owner;
+      if (owner === undefined) {
+        const completeAddresses = (await this.db.getCompleteAddresses()).find(address =>
+          address.publicKey.equals(dao.publicKey),
+        );
+        if (completeAddresses === undefined) {
+          throw new Error(`Cannot find complete address for public key ${dao.publicKey.toString()}`);
+        }
+        owner = completeAddresses.address;
+      }
+      return new ExtendedNote(dao.note, owner, dao.contractAddress, dao.storageSlot, dao.txHash);
+    });
+    return Promise.all(extendedNotes);
+  }
+
+  public async addNote(note: ExtendedNote) {
+    const { publicKey } = (await this.db.getCompleteAddress(note.owner)) ?? {};
     if (!publicKey) {
       throw new Error('Unknown account.');
     }
 
+    const [nonce] = await this.getNoteNonces(note);
     if (!nonce) {
-      [nonce] = await this.getNoteNonces(contractAddress, storageSlot, preimage, txHash);
-    }
-    if (!nonce) {
-      throw new Error(`Cannot find the note in tx: ${txHash}.`);
+      throw new Error(`Cannot find the note in tx: ${note.txHash}.`);
     }
 
     const { innerNoteHash, siloedNoteHash, uniqueSiloedNoteHash, innerNullifier } =
-      await this.simulator.computeNoteHashAndNullifier(contractAddress, nonce, storageSlot, preimage.items);
+      await this.simulator.computeNoteHashAndNullifier(note.contractAddress, nonce, note.storageSlot, note.note);
 
     // TODO(https://github.com/AztecProtocol/aztec-packages/issues/1386)
     // This can always be `uniqueSiloedNoteHash` once notes added from public also include nonces.
@@ -236,33 +238,31 @@ export class PXEService implements PXE {
     }
 
     const wasm = await CircuitsWasm.get();
-    const siloedNullifier = siloNullifier(wasm, contractAddress, innerNullifier!);
+    const siloedNullifier = siloNullifier(wasm, note.contractAddress, innerNullifier!);
     const nullifierIndex = await this.node.findLeafIndex(MerkleTreeId.NULLIFIER_TREE, siloedNullifier.toBuffer());
     if (nullifierIndex !== undefined) {
       throw new Error('The note has been destroyed.');
     }
 
-    await this.db.addNoteSpendingInfo({
-      contractAddress,
-      storageSlot,
-      notePreimage: preimage,
-      nonce,
-      innerNoteHash,
-      siloedNullifier,
-      index,
-      publicKey,
-    });
+    await this.db.addNote(
+      new NoteDao(
+        note.note,
+        note.contractAddress,
+        note.storageSlot,
+        note.txHash,
+        nonce,
+        innerNoteHash,
+        siloedNullifier,
+        index,
+        publicKey,
+      ),
+    );
   }
 
-  public async getNoteNonces(
-    contractAddress: AztecAddress,
-    storageSlot: Fr,
-    preimage: NotePreimage,
-    txHash: TxHash,
-  ): Promise<Fr[]> {
-    const tx = await this.node.getTx(txHash);
+  public async getNoteNonces(note: ExtendedNote): Promise<Fr[]> {
+    const tx = await this.node.getTx(note.txHash);
     if (!tx) {
-      throw new Error(`Unknown tx: ${txHash}`);
+      throw new Error(`Unknown tx: ${note.txHash}`);
     }
 
     const wasm = await CircuitsWasm.get();
@@ -276,10 +276,10 @@ export class PXEService implements PXE {
 
       const nonce = computeCommitmentNonce(wasm, firstNullifier, i);
       const { siloedNoteHash, uniqueSiloedNoteHash } = await this.simulator.computeNoteHashAndNullifier(
-        contractAddress,
+        note.contractAddress,
         nonce,
-        storageSlot,
-        preimage.items,
+        note.storageSlot,
+        note.note,
       );
       // TODO(https://github.com/AztecProtocol/aztec-packages/issues/1386)
       // Remove this once notes added from public also include nonces.
@@ -395,7 +395,9 @@ export class PXEService implements PXE {
   async #getFunctionCall(functionName: string, args: any[], to: AztecAddress): Promise<FunctionCall> {
     const contract = await this.db.getContract(to);
     if (!contract) {
-      throw new Error(`Unknown contract ${to}: add it to PXE Service by calling server.addContracts(...)`);
+      throw new Error(
+        `Unknown contract ${to}: add it to PXE Service by calling server.addContracts(...).\nSee docs for context: https://docs.aztec.network/dev_docs/contracts/common_errors#unknown-contract-error`,
+      );
     }
 
     const functionDao = contract.functions.find(f => f.name === functionName);

package/src/simulator_oracle/index.ts

@@ -33,7 +33,7 @@ export class SimulatorOracle implements DBOracle {
     const completeAddress = await this.db.getCompleteAddress(address);
     if (!completeAddress)
       throw new Error(
-        `No public key registered for address ${address.toString()}. Register it by calling pxe.registerRecipient(...) or pxe.registerAccount(...)`,
+        `No public key registered for address ${address.toString()}. Register it by calling pxe.registerRecipient(...) or pxe.registerAccount(...).\nSee docs for context: https://docs.aztec.network/dev_docs/contracts/common_errors#no-public-key-registered-error`,
       );
     return completeAddress;
   }
@@ -45,19 +45,17 @@ export class SimulatorOracle implements DBOracle {
   }
 
   async getNotes(contractAddress: AztecAddress, storageSlot: Fr) {
-    const noteDaos = await this.db.getNoteSpendingInfo(contractAddress, storageSlot);
-    return noteDaos.map(
-      ({ contractAddress, storageSlot, nonce, notePreimage, innerNoteHash, siloedNullifier, index }) => ({
-        contractAddress,
-        storageSlot,
-        nonce,
-        preimage: notePreimage.items,
-        innerNoteHash,
-        siloedNullifier,
-        // PXE can use this index to get full MembershipWitness
-        index,
-      }),
-    );
+    const noteDaos = await this.db.getNotes({ contractAddress, storageSlot });
+    return noteDaos.map(({ contractAddress, storageSlot, nonce, note, innerNoteHash, siloedNullifier, index }) => ({
+      contractAddress,
+      storageSlot,
+      nonce,
+      note,
+      innerNoteHash,
+      siloedNullifier,
+      // PXE can use this index to get full MembershipWitness
+      index,
+    }));
   }
 
   async getFunctionArtifact(
@@ -72,6 +70,22 @@ export class SimulatorOracle implements DBOracle {
     };
   }
 
+  async getFunctionArtifactByName(
+    contractAddress: AztecAddress,
+    functionName: string,
+  ): Promise<FunctionArtifactWithDebugMetadata | undefined> {
+    const artifact = await this.contractDataOracle.getFunctionArtifactByName(contractAddress, functionName);
+    if (!artifact) {
+      return;
+    }
+
+    const debug = await this.contractDataOracle.getFunctionDebugMetadata(contractAddress, artifact.selector);
+    return {
+      ...artifact,
+      debug,
+    };
+  }
+
   async getPortalContractAddress(contractAddress: AztecAddress): Promise<EthAddress> {
     return await this.contractDataOracle.getPortalContractAddress(contractAddress);
   }
@@ -88,7 +102,7 @@ export class SimulatorOracle implements DBOracle {
     const messageAndIndex = await this.stateInfoProvider.getL1ToL2MessageAndIndex(msgKey);
     const message = messageAndIndex.message.toFieldArray();
     const index = messageAndIndex.index;
-    const siblingPath = await this.stateInfoProvider.getL1ToL2MessagesTreePath(index);
+    const siblingPath = await this.stateInfoProvider.getL1ToL2MessageSiblingPath(index);
     return {
       message,
       siblingPath: siblingPath.toFieldArray(),

package/dest/database/note_spending_info_dao.d.ts

@@ -1,50 +0,0 @@
-import { AztecAddress, Fr, PublicKey } from '@aztec/circuits.js';
-import { NotePreimage } from '@aztec/types';
-/**
- * Represents the data access object for auxiliary transaction data.
- * Contains properties from the decrypted note, computed properties, and information about
- * the public key used for encryption, as well as the location of the data in the tree.
- */
-export interface NoteSpendingInfoDao {
-    /**
-     * The contract address this note is created in.
-     */
-    contractAddress: AztecAddress;
-    /**
-     * The nonce of the note.
-     */
-    nonce: Fr;
-    /**
-     * The specific storage location of the note on the contract.
-     */
-    storageSlot: Fr;
-    /**
-     * The preimage of the note, containing essential information about the note.
-     */
-    notePreimage: NotePreimage;
-    /**
-     * Inner note hash of the note. This is customizable by the app circuit.
-     * We can use this value to compute siloedNoteHash and uniqueSiloedNoteHash.
-     */
-    innerNoteHash: Fr;
-    /**
-     * The nullifier of the note (siloed by contract address).
-     */
-    siloedNullifier: Fr;
-    /**
-     * The location of the relevant note in the note hash tree.
-     */
-    index: bigint;
-    /**
-     * The public key that was used to encrypt the data.
-     */
-    publicKey: PublicKey;
-}
-export declare const createRandomNoteSpendingInfoDao: ({ contractAddress, nonce, storageSlot, notePreimage, innerNoteHash, siloedNullifier, index, publicKey, }?: Partial<NoteSpendingInfoDao>) => NoteSpendingInfoDao;
-/**
- * Returns the size in bytes of a note spending info dao.
- * @param note - The note.
- * @returns - Its size in bytes.
- */
-export declare function getNoteSpendingInfoDaoSize(note: NoteSpendingInfoDao): number;
-//# sourceMappingURL=note_spending_info_dao.d.ts.map

package/dest/database/note_spending_info_dao.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"note_spending_info_dao.d.ts","sourceRoot":"","sources":["../../src/database/note_spending_info_dao.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEjE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,eAAe,EAAE,YAAY,CAAC;IAC9B;;OAEG;IACH,KAAK,EAAE,EAAE,CAAC;IACV;;OAEG;IACH,WAAW,EAAE,EAAE,CAAC;IAChB;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAC3B;;;OAGG;IACH,aAAa,EAAE,EAAE,CAAC;IAClB;;OAEG;IACH,eAAe,EAAE,EAAE,CAAC;IACpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,eAAO,MAAM,+BAA+B,8GASzC,QAAQ,mBAAmB,CAAC,KAAQ,mBASrC,CAAC;AAEH;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,mBAAmB,UAInE"}

package/dest/database/note_spending_info_dao.js

@@ -1,24 +0,0 @@
-import { AztecAddress, Fr } from '@aztec/circuits.js';
-import { Point } from '@aztec/foundation/fields';
-import { NotePreimage } from '@aztec/types';
-export const createRandomNoteSpendingInfoDao = ({ contractAddress = AztecAddress.random(), nonce = Fr.random(), storageSlot = Fr.random(), notePreimage = NotePreimage.random(), innerNoteHash = Fr.random(), siloedNullifier = Fr.random(), index = Fr.random().value, publicKey = Point.random(), } = {}) => ({
-    contractAddress,
-    nonce,
-    storageSlot,
-    notePreimage,
-    innerNoteHash,
-    siloedNullifier,
-    index,
-    publicKey,
-});
-/**
- * Returns the size in bytes of a note spending info dao.
- * @param note - The note.
- * @returns - Its size in bytes.
- */
-export function getNoteSpendingInfoDaoSize(note) {
-    // 7 fields + 1 bigint + 1 buffer size (4 bytes) + 1 buffer
-    const indexSize = Math.ceil(Math.log2(Number(note.index)));
-    return 7 * Fr.SIZE_IN_BYTES + indexSize + 4 + note.notePreimage.items.length * Fr.SIZE_IN_BYTES;
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm90ZV9zcGVuZGluZ19pbmZvX2Rhby5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9kYXRhYmFzZS9ub3RlX3NwZW5kaW5nX2luZm9fZGFvLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxZQUFZLEVBQUUsRUFBRSxFQUFhLE1BQU0sb0JBQW9CLENBQUM7QUFDakUsT0FBTyxFQUFFLEtBQUssRUFBRSxNQUFNLDBCQUEwQixDQUFDO0FBQ2pELE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSxjQUFjLENBQUM7QUEyQzVDLE1BQU0sQ0FBQyxNQUFNLCtCQUErQixHQUFHLENBQUMsRUFDOUMsZUFBZSxHQUFHLFlBQVksQ0FBQyxNQUFNLEVBQUUsRUFDdkMsS0FBSyxHQUFHLEVBQUUsQ0FBQyxNQUFNLEVBQUUsRUFDbkIsV0FBVyxHQUFHLEVBQUUsQ0FBQyxNQUFNLEVBQUUsRUFDekIsWUFBWSxHQUFHLFlBQVksQ0FBQyxNQUFNLEVBQUUsRUFDcEMsYUFBYSxHQUFHLEVBQUUsQ0FBQyxNQUFNLEVBQUUsRUFDM0IsZUFBZSxHQUFHLEVBQUUsQ0FBQyxNQUFNLEVBQUUsRUFDN0IsS0FBSyxHQUFHLEVBQUUsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxLQUFLLEVBQ3pCLFNBQVMsR0FBRyxLQUFLLENBQUMsTUFBTSxFQUFFLE1BQ00sRUFBRSxFQUF1QixFQUFFLENBQUMsQ0FBQztJQUM3RCxlQUFlO0lBQ2YsS0FBSztJQUNMLFdBQVc7SUFDWCxZQUFZO0lBQ1osYUFBYTtJQUNiLGVBQWU7SUFDZixLQUFLO0lBQ0wsU0FBUztDQUNWLENBQUMsQ0FBQztBQUVIOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsMEJBQTBCLENBQUMsSUFBeUI7SUFDbEUsMkRBQTJEO0lBQzNELE1BQU0sU0FBUyxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUMzRCxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUMsYUFBYSxHQUFHLFNBQVMsR0FBRyxDQUFDLEdBQUcsSUFBSSxDQUFDLFlBQVksQ0FBQyxLQUFLLENBQUMsTUFBTSxHQUFHLEVBQUUsQ0FBQyxhQUFhLENBQUM7QUFDbEcsQ0FBQyJ9

package/src/database/note_spending_info_dao.ts

@@ -1,75 +0,0 @@
-import { AztecAddress, Fr, PublicKey } from '@aztec/circuits.js';
-import { Point } from '@aztec/foundation/fields';
-import { NotePreimage } from '@aztec/types';
-
-/**
- * Represents the data access object for auxiliary transaction data.
- * Contains properties from the decrypted note, computed properties, and information about
- * the public key used for encryption, as well as the location of the data in the tree.
- */
-export interface NoteSpendingInfoDao {
-  /**
-   * The contract address this note is created in.
-   */
-  contractAddress: AztecAddress;
-  /**
-   * The nonce of the note.
-   */
-  nonce: Fr;
-  /**
-   * The specific storage location of the note on the contract.
-   */
-  storageSlot: Fr;
-  /**
-   * The preimage of the note, containing essential information about the note.
-   */
-  notePreimage: NotePreimage;
-  /**
-   * Inner note hash of the note. This is customizable by the app circuit.
-   * We can use this value to compute siloedNoteHash and uniqueSiloedNoteHash.
-   */
-  innerNoteHash: Fr;
-  /**
-   * The nullifier of the note (siloed by contract address).
-   */
-  siloedNullifier: Fr;
-  /**
-   * The location of the relevant note in the note hash tree.
-   */
-  index: bigint;
-  /**
-   * The public key that was used to encrypt the data.
-   */
-  publicKey: PublicKey;
-}
-
-export const createRandomNoteSpendingInfoDao = ({
-  contractAddress = AztecAddress.random(),
-  nonce = Fr.random(),
-  storageSlot = Fr.random(),
-  notePreimage = NotePreimage.random(),
-  innerNoteHash = Fr.random(),
-  siloedNullifier = Fr.random(),
-  index = Fr.random().value,
-  publicKey = Point.random(),
-}: Partial<NoteSpendingInfoDao> = {}): NoteSpendingInfoDao => ({
-  contractAddress,
-  nonce,
-  storageSlot,
-  notePreimage,
-  innerNoteHash,
-  siloedNullifier,
-  index,
-  publicKey,
-});
-
-/**
- * Returns the size in bytes of a note spending info dao.
- * @param note - The note.
- * @returns - Its size in bytes.
- */
-export function getNoteSpendingInfoDaoSize(note: NoteSpendingInfoDao) {
-  // 7 fields + 1 bigint + 1 buffer size (4 bytes) + 1 buffer
-  const indexSize = Math.ceil(Math.log2(Number(note.index)));
-  return 7 * Fr.SIZE_IN_BYTES + indexSize + 4 + note.notePreimage.items.length * Fr.SIZE_IN_BYTES;
-}